cronitor 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 67371ddbb668fc2c736994aadb6b1610bd807aa4
-  data.tar.gz: 22381ccb4ee4157fe32c3d518642976aa58a63d9
+SHA256:
+  metadata.gz: 1f6ea3528a80a4d2cb84314c86bb5f55431706aa46c9a5ca787860e8823f7bbd
+  data.tar.gz: 3467ef223aafddbab324b924fdc5552922f12310f959d32b7137eedf2ea42b98
 SHA512:
-  metadata.gz: fde7ed9489dd3b82435766ed0013dcef88fb2fe7f67ecca2e3cd7d954c3fff2c164df8e5af2a9b59343b5587c5d287df4a229968d1b4d306ea916605b81a0329
-  data.tar.gz: 0e342c25712223f1b1f8e67c11b606bf75369a494c00f0bd3aacb6bc0c87272b8b6b44f5b2e0f81d5613779eabdaf95289716a0e2d639f20ba2e0453c252cad3
+  metadata.gz: a54a8268d276563c0c90cc6101ccf7db4e6aa725568b08bd7581c4d7c745fee78e5245ad51e4ac3d752370048bf09151b315f5eb3c829c345f1c81e9e1ff8fbf
+  data.tar.gz: 8db8d9075d2daf231b54dbc2d0276448e5e39e07e0a9996ff8d8087e65f20971e105344d75f4b36812fd8a549d0f477a9dc78fd6231234f4cb932f5f182d76ed

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,3 +1,5 @@
+---
 language: ruby
 rvm:
+  - 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.
@@ -29,11 +29,16 @@ Or install it yourself as:
 
 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 +48,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
 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 +76,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 +101,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,11 +20,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  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 'bump', '~> 0.1'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'pry', '~> 0.10'
-  spec.add_development_dependency 'webmock', '~> 3.1'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.3'
   spec.add_development_dependency 'sinatra', '~> 2.0'
-  spec.add_development_dependency 'bump', '~> 0.1'
+  spec.add_development_dependency 'webmock', '~> 3.1'
 end

data/lib/cronitor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cronitor/version'
 require 'cronitor/error'
 require 'json'
@@ -6,8 +8,8 @@ require 'uri'
 
 class Cronitor
   attr_accessor :token, :opts, :code
-  API_URL = 'https://cronitor.io/v1'.freeze
-  PING_URL = 'https://cronitor.link'.freeze
+  API_URL = 'https://cronitor.io/v3'
+  PING_URL = 'https://cronitor.link'
 
   def initialize(token: ENV['CRONITOR_TOKEN'], opts: {}, code: nil)
     @token = token
@@ -24,8 +26,14 @@ class Cronitor
 
     if @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?
@@ -61,6 +69,7 @@ class Cronitor
     return false unless response.is_a? Net::HTTPSuccess
 
     @code = JSON.parse(response.body).fetch 'code'
+    @opts = JSON.parse(response.body)
 
     true
   end
@@ -81,15 +90,6 @@ class Cronitor
     valid? response
   end
 
-  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
-  end
-
   private
 
   def valid?(response)

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 = '2.0.0'.freeze
+  VERSION = '3.0.0'
 end

metadata

@@ -1,85 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: cronitor
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jeff Byrnes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-30 00:00:00.000000000 Z
+date: 2020-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   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
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -95,19 +95,19 @@ dependencies:
       - !ruby/object:Gem::Version
         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'
+        version: '3.1'
 description: 
 email:
 - thejeffbyrnes@gmail.com
@@ -118,6 +118,7 @@ files:
 - ".editorconfig"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -147,8 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: An interface for the Cronitor API