cronitor 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfb4bc2a6d6edac6fd2f95844f1960ed7fb1386b
-  data.tar.gz: 95ba43106ee758681c6e681e9e0a388bbe810437
+  metadata.gz: 97f852a88bb9a1d55729161521e841a533198f5b
+  data.tar.gz: f8202fa60a98954c8d45c66e00aecdb0e67e449e
 SHA512:
-  metadata.gz: 12995df33e43f2a6959b2662eb4a99c3162fa869376a09c3795ed3b2a78c5fedf8b87bac7d2d275930a6d6f6aabe1e9bfe783e5c05e9496f19f8283a394ee3cd
-  data.tar.gz: e237a122016b09638091f012a7a03e902310e01e8fe0aa9aacdf91e7042481cf96f1e0e584835e919fe5cc7739ecdfab711949eb6e89623f4f67b8ff0664c1dc
+  metadata.gz: d4a60d0d6c8de4afd286d00e9869e0f5a26bd593c630521869e84dc5c04f833f1ed92c0231709a80675e80176e381755f7c821857205bcd5b36a062ec0321993
+  data.tar.gz: 9d667dcc744903d1324b11ec824c7d2d387a18effd5cc93ed7a8b4cf45c920a8741f4b6f8a3b4b32edf993d13fa2649b5cfcf934903654431150b1068a4cb68f

data/README.md

@@ -33,26 +33,40 @@ A Cronitor monitor (hereafter referred to only as a monitor for brevity) is crea
 require 'cronitor'
 
 monitor_options = {
-    name: 'My Fancy Monitor',
-    notifications: {
-        emails: ['test@example.com'],
-        slack: [],
-        pagerduty: [],
-        phones: [],
-        webhooks: []
-    },
-    rules: [
-        {
-            rule_type: 'not_run_in',
-            duration: 5
-            time_unit: 'seconds'
-        }
-    ],
-    note: 'A human-friendly description of this monitor'
+  name: 'My Fancy Monitor',
+  notifications: {
+    emails: ['test@example.com'],
+    slack: [],
+    pagerduty: [],
+    phones: [],
+    webhooks: []
+  },
+  rules: [
+    {
+      rule_type: 'not_run_in',
+      duration: 5
+      rime_unit: 'seconds'
+    }
+  ],
+  note: 'A human-friendly description of this monitor'
 }
 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:
+
+```ruby
+monitor_options = {
+  rules: [
+    {
+      rule_type: 'not_run_in',
+      duration: 5
+      time_unit: 'seconds',
+      human_readable: 'not_run_in 5 seconds'
+    }
+  ],
+```
+
 ### 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`.

data/lib/cronitor.rb

@@ -51,6 +51,18 @@ class Cronitor
     true
   end
 
+  def run
+    ping 'run'
+  end
+
+  def complete
+    ping 'complete'
+  end
+
+  def fail(msg = nil)
+    ping 'fail', msg
+  end
+
   def ping(type, msg = nil)
     url = "#{PING_URL}/#{code}/#{type}"
     url += "?msg=#{URI.escape msg}" if type == 'fail' && !msg.nil?

data/lib/cronitor/version.rb

@@ -1,3 +1,3 @@
 class Cronitor
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronitor
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jeff Byrnes