cronitor 1.1.3 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8f2d92e9bff2665cff64e293fa9a2811fdd0f1ac
-  data.tar.gz: cc05a4d335a3a7272e1fe5430cc8e8ba5526bdd6
+SHA256:
+  metadata.gz: f4b5bc9e1efd7fb5247f7f473195589fb4cb822c52a1ee92f1b6c784086016f7
+  data.tar.gz: f617431b175f6c2e9263fc48fece1af7d7bff634285d703e5d3d57d548f70236
 SHA512:
-  metadata.gz: 39b1571f0e348dadc27d5df8d36d53afeb8a65e2b750ec6e05dc93f1afa01b42d3da13adf629baa2c32509df988d74ce3717d810c4d70a90c2628943366c5a98
-  data.tar.gz: 384b8b8dece34c4d81057eafa338d0f9c8374fcb5988acaeb6010ac9241774236065b1b5b37f9af24060aa686f0ac511c4667b0a1e65d2ffaea785c55bb6c5b8
+  metadata.gz: 88a42cddedfea16c32fe0ab3716684343f7c6e8adcfa9cd5018a43e28c6e1e86ba9ced38cfe361e1ecc184dde146f2b8b222320ce17c2e8e1194c4d698d55e20
+  data.tar.gz: 5ecb82ea549bd5a5ffb5d4298f493e40d3e2569d1517365156315a30f965fbe8b46629daf3bcae9cd029b93ad14c8363d6f06e0f543d8b26a0e270567446dc61

data/.rubocop.yml

@@ -0,0 +1,15 @@
+---
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -1,4 +1,5 @@
+---
 language: ruby
 rvm:
-  - 2.2
-before_install: gem install bundler -v 1.10
+  - 2
+  - 2.4

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cronitor.gemspec

data/README.md

@@ -1,6 +1,6 @@
 # Cronitor
 
-[![Travis](https://img.shields.io/travis/evertrue/cronitor.svg)](https://github.com/evertrue/cronitor)
+[![Travis](https://img.shields.io/travis/evertrue/cronitor.svg)](https://travis-ci.org/evertrue/cronitor)
 [![Gem Version](https://badge.fury.io/rb/cronitor.svg)](https://badge.fury.io/rb/cronitor)
 
 [Cronitor](https://cronitor.io/) is a service for heartbeat-style monitoring of just about anything that can send an HTTP request.
@@ -25,15 +25,45 @@ Or install it yourself as:
 
 ## Usage
 
+
+### Configure
+
+You need to set Cronitor Token in order to create a monitor
+
+#### Using configure
+
+```ruby
+require 'cronitor'
+
+Cronitor.configure do |cronitor|
+  cronitor.default_token = 'token' # default token to be re-used by cronitor
+end
+```
+
+#### Using ENV
+
+```
+# .env
+CRONITOR_TOKEN: token
+
+# bash
+export CRONITOR_TOKEN='token'
+```
+
 ### 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.
 
+Please see the [Cronitor Monitor API docs](https://cronitor.io/docs/monitor-api) for details of all the possible monitor options.
+
+Example of creating a heartbeat monitor:
+
 ```ruby
 require 'cronitor'
 
 monitor_options = {
   name: 'My Fancy Monitor',
+  type: 'heartbeat', # Optional: the gem defaults to this; the other value, 'healthcheck', is not yet supported by this gem
   notifications: {
     emails: ['test@example.com'],
     slack: [],
@@ -43,29 +73,21 @@ monitor_options = {
   },
   rules: [
     {
-      rule_type: 'not_run_in',
-      duration: 5
-      rime_unit: 'seconds'
+      rule_type: 'run_ping_not_received',
+      value: 5,
+      time_unit: 'seconds'
     }
   ],
   note: 'A human-friendly description of this monitor'
 }
+
+# The token parameter is optional; if omittted, ENV['CRONITOR_TOKEN'] will be used if not configured
 my_monitor = Cronitor.new token: 'api_token', opts: monitor_options
 ```
 
-You may optionally specify a `:human_readable` value for your rule(s), otherwise one will be crafted for you:
+### Updating an existing monitor
 
-```ruby
-monitor_options = {
-  rules: [
-    {
-      rule_type: 'not_run_in',
-      duration: 5
-      time_unit: 'seconds',
-      human_readable: 'not_run_in 5 seconds'
-    }
-  ],
-```
+Currently this gem does not support updating or deleting an existing monitor.
 
 ### Pinging a Monitor
 
@@ -79,7 +101,9 @@ my_monitor.ping '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).
+You may already have the code for a monitor, in which case, the expense of `Cronitor.create` may seem unnecessary (since it makes an HTTP request to check if a monitor exists, and you already know it does).
+
+Cronitor does not require a token for pinging a monitor unless you have enabled Ping API authentication in your account settings. At the moment, this gem does not support Ping API auth.
 
 In that case:
 
@@ -102,3 +126,10 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 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
+
+## Release a new version
+
+The `bump` gem makes this easy:
+
+1. `rake bump:(major|minor|patch|pre)`
+2. `rake release`

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'bump/tasks'

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'cronitor'

data/cronitor.gemspec

@@ -1,4 +1,6 @@
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cronitor/version'
 
@@ -18,14 +20,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'unirest', '~> 1.1'
-  spec.add_dependency 'hashie', '~> 3.4'
-
-  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'
   spec.add_development_dependency 'bump', '~> 0.1'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'sinatra', '~> 2.0'
+  spec.add_development_dependency 'webmock', '~> 3.1'
 end

data/lib/cronitor.rb

@@ -1,23 +1,31 @@
+# frozen_string_literal: true
+
 require 'cronitor/version'
 require 'cronitor/error'
+require 'json'
 require 'net/http'
-require 'unirest'
-
-Unirest.default_header 'Accept', 'application/json'
-Unirest.default_header 'Content-Type', 'application/json'
+require 'uri'
 
 class Cronitor
   attr_accessor :token, :opts, :code
-  API_URL = 'https://cronitor.io/v1'
+  API_URL = 'https://cronitor.io/v3'
   PING_URL = 'https://cronitor.link'
 
-  def initialize(token: nil, opts: {}, code: nil)
-    @token = token
+  class << self
+    attr_accessor :default_token
+
+    def configure(&block)
+      block.call(self)
+    end
+  end
+
+  def initialize(token: ENV['CRONITOR_TOKEN'], opts: {}, code: nil)
+    @token = token || self.class.default_token
     @opts = opts
     @code = code
 
     if @token.nil? && @code.nil?
-      fail(
+      raise(
         Cronitor::Error,
         'Either a Cronitor API token or an existing monitor code must be ' \
         'provided'
@@ -25,60 +33,83 @@ class Cronitor
     end
 
     if @opts
-      Hashie.symbolize_keys! @opts
+      @opts = symbolize_keys @opts
+
       exists? @opts[:name] if @opts.key? :name
-      human_readable @opts[:rules] if @opts.key? :rules
+
+      # README: Per Cronitor API v2, we need to specify a type. The "heartbeat"
+      #         type corresponds to what the v1 API offered by default
+      #         We allow other values to be injected, and let the API handle
+      #         any errors.
+      @opts[:type] = 'heartbeat' unless @opts[:type]
     end
 
     create if @code.nil?
   end
 
   def create
-    response = Unirest.post(
-      "#{API_URL}/monitors",
-      auth: { user: token },
-      parameters: opts.to_json
-    )
+    uri = URI.parse "#{API_URL}/monitors"
+
+    http = Net::HTTP.new uri.host, uri.port
+    http.use_ssl = uri.scheme == 'https'
+
+    request = Net::HTTP::Post.new uri.path, default_headers
+    request.basic_auth token, nil
+    request.content_type = 'application/json'
+    request.body = JSON.generate opts
 
-    @code = response.body['code'] if valid? response
+    response = http.request request
+
+    @code = JSON.parse(response.body).fetch 'code' if valid? response
   end
 
   def exists?(name)
-    response = Unirest.get(
-      "#{API_URL}/monitors/#{URI.escape(name).gsub('[', '%5B').gsub(']', '%5D')}",
-      auth: { user: token }
-    )
-    return false unless response.code == 200
+    uri = URI.parse "#{API_URL}/monitors/#{URI.escape name}"
+
+    http = Net::HTTP.new uri.host, uri.port
+    http.use_ssl = uri.scheme == 'https'
+
+    request = Net::HTTP::Get.new uri.path, default_headers
+    request.basic_auth token, nil
 
-    @code = response.body['code']
+    response = http.request request
+
+    return false unless response.is_a? Net::HTTPSuccess
+
+    @code = JSON.parse(response.body).fetch 'code'
+    @opts = JSON.parse(response.body)
 
     true
   end
 
   def ping(type, msg = nil)
-    url = "#{PING_URL}/#{code}/#{type}"
-    url += "?msg=#{URI.escape msg}" if type == 'fail' && !msg.nil?
+    uri = URI.parse "#{PING_URL}/#{URI.escape code}/#{URI.escape type}"
+    if %w[run complete fail].include?(type) && !msg.nil?
+      uri.query = URI.encode_www_form 'msg' => msg
+    end
 
-    response = Unirest.get url
-    valid? response
-  end
+    http = Net::HTTP.new uri.host, uri.port
+    http.use_ssl = uri.scheme == 'https'
 
-  def human_readable(rules)
-    rules.each do |rule|
-      unless rule[:human_readable]
-        rule[:human_readable] = "#{rule[:rule_type]} #{rule[:duration]} " \
-                                "#{rule[:time_unit]}"
-      end
-    end
+    request = Net::HTTP::Get.new uri, default_headers
+
+    response = http.request request
+
+    valid? response
   end
 
   private
 
   def valid?(response)
-    return true if [200, 201].include? response.code
-    server_error? response
+    return true if response.is_a? Net::HTTPSuccess
 
-    fail Cronitor::Error, error_msg(response.body)
+    msg = if response.content_type.match? 'json'
+            error_msg JSON.parse(response.body)
+          else
+            "Something else has gone awry. HTTP status: #{response.code}"
+          end
+
+    raise Cronitor::Error, msg
   end
 
   def error_msg(body, msg = [])
@@ -95,12 +126,13 @@ class Cronitor
     msg.join ' '
   end
 
-  def server_error?(response)
-    return unless [301, 302, 404, 500, 502, 503, 504].include? response.code
+  def default_headers
+    { 'Accept' => 'application/json' }
+  end
 
-    fail(
-      Cronitor::Error,
-      "Something else has gone awry. HTTP status: #{response.code}"
-    )
+  def symbolize_keys(hash)
+    hash.each_with_object({}) do |(k, v), h|
+      h[k.to_sym] = v.is_a?(Hash) ? symbolize_keys(v) : v
+    end
   end
 end

data/lib/cronitor/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Cronitor
   class Error < StandardError
   end

data/lib/cronitor/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Cronitor
-  VERSION = '1.1.3'
+  VERSION = '3.1.0'
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: cronitor
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 3.1.0
 platform: ruby
 authors:
 - Jeff Byrnes
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2020-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: unirest
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
+        version: '0.1'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,63 +80,35 @@ dependencies:
     - - "~>"
       - !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'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: bump
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-description: 
+        version: '3.1'
+description:
 email:
 - thejeffbyrnes@gmail.com
 executables: []
@@ -146,6 +118,7 @@ files:
 - ".editorconfig"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -160,7 +133,7 @@ files:
 homepage: https://github.com/evertrue/cronitor
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -175,9 +148,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: An interface for the Cronitor API
 test_files: []