cronitor 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac1824833468d92068ba5664ef8d667fbe2518b34caa8da2cae3a307a7a923e7
-  data.tar.gz: 18ff6d1f48bd6da9686930585b6eaab3d296caedb33c171a5d668c26b69fdaba
+  metadata.gz: 55b057acd03a6a25b77974f2834d1f9d0a745e94089b5a8f1a7b19b74cdbd291
+  data.tar.gz: 6eea2063baf3f2a31a4f67ee27d419b70ac94127f18216fb5dcc555d042a8bc6
 SHA512:
-  metadata.gz: 3d6e6aeaaaf3c0a8e5942132e833f53169756717dfa49d52d6641dc0a644f470cac6cc2124fdaebf12fb7814b485f9a14753c78a2a059541b94662c9127279a7
-  data.tar.gz: e2d4da41d199b4ff8c01fa768f69f0a48303c98559a2766f537b0a25f6940df21c0ecd2c94d4318636623f230cd8ff7976b75a3219ece9cae419b6eafa8b10ff
+  metadata.gz: c88b28e6b24c779f522b93e6dd6a6b57da6bc7df615d393b3dec35f76c7577d5b5cf0710a0d8e54b5f73f88210543426362eee35fe0641f8c63aa63ff40f3331
+  data.tar.gz: f20d7064b7dde42ec30c6ee46bbeb7fa38323e17053737cc2fe127257aaf74e6a4ee67850bd77be4eb5d2f4454e2665f1e01a4141b2b424d0958be97f6dd2bd4

data/README.md

@@ -1,6 +1,6 @@
 # Cronitor Ruby Library
 
-![Test](https://github.com/cronitorio/cronitor-ruby/workflows/Test/badge.svg)
+![Tests](https://github.com/cronitorio/cronitor-ruby/workflows/Test/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/cronitor.svg)](https://badge.fury.io/rb/cronitor)
 
 
@@ -62,6 +62,8 @@ monitor.ping(state: 'complete', metrics: {count: 1000, error_count: 17})
 
 ## Configuring Monitors
 
+### Using a YAML configuration file
+
 You can configure all of your monitors using a single YAML file. This can be version controlled and synced to Cronitor as part of
 a deployment or build process. For details on all of the attributes that can be set, see the [Monitor API](https://cronitor.io/docs/monitor-api) documentation.
 
@@ -127,38 +129,65 @@ heartbeats:
 
 ```
 
-You can also create and update monitors by calling `Monitor.put`.
+### Using `Cronitor::Monitor.put`
+
+You can also create and update monitors by calling `Cronitor::Monitor.put`. This method can handle multiple monitors at once and supports various configurations and options.
+
 
+#### Usage
 ```ruby
 require 'cronitor'
 
+# Define monitors as an array of hashes
 monitors = [
   {
     type: 'job',
     key: 'send-customer-invoices',
     schedule: '0 0 * * *',
-    assertions: [
-        'metric.duration < 5 min'
-    ],
+    assertions: ['metric.duration < 5 min'],
     notify: ['devops-alerts-slack']
   },
   {
     type: 'check',
     key: 'Cronitor Homepage',
-    request: {
-        url: 'https://cronitor.io'
-    },
+    request: { url: 'https://cronitor.io' },
     schedule: 'every 60 seconds',
     assertions: [
-        'response.code = 200',
-        'response.time < 600ms',
+      'response.code = 200',
+      'response.time < 600ms'
     ]
   }
 ]
 
-Cronitor::Monitor.put(monitors)
+# Options hash with monitors array
+options = {
+  monitors: monitors,
+  format: 'json', # Optional, can be 'json' or 'yaml'
+  rollback: false, # Optional, default is false
+  timeout: 10 # Optional, specify request timeout in seconds
+}
+
+# Create or update monitors
+Cronitor::Monitor.put(options)
 ```
 
+#### Parameters
+- `monitors`: An array of monitor configuration hashes.
+- `options`: A hash containing:
+  - `:monitors`: An array of monitor hashes (required).
+  - `:format`: String, format of the request ('json' or 'yaml'). Default is 'json'.
+  - `:rollback`: Boolean, indicates whether to rollback on failure. Default is `false`.
+  - `:timeout`: Integer, request timeout in seconds. Falls back to `Cronitor.timeout` if not specified.
+
+#### Return Value
+Depending on the `:format` option, this method returns:
+- For JSON: An array of `Cronitor::Monitor` instances or a single instance if only one monitor is provided.
+- For YAML: The parsed response body.
+
+#### Error Handling
+- `ValidationError`: Raised when the API returns a 400 status code, indicating invalid monitor configurations.
+- `Error`: Raised for other non-successful responses, indicating issues with connecting to the Cronitor API.
+
 ### Pause, Reset, Delete
 
 ```ruby

data/lib/cronitor/config.rb

@@ -9,20 +9,22 @@ module Cronitor
   YAML_KEYS = MONITOR_TYPES.map { |t| "#{t}s" }
 
   class << self
-    attr_accessor :api_key, :api_version, :environment, :logger, :config, :timeout, :ping_timeout, :auto_discover_sidekiq
+    attr_accessor :api_key, :api_version, :environment, :logger, :config, :timeout, :ping_timeout, :auto_discover_sidekiq, :telemetry_domain
 
     def configure(&block)
       block.call(self)
     end
+
   end
 
   self.api_key = ENV.fetch('CRONITOR_API_KEY', nil)
   self.api_version = ENV.fetch('CRONITOR_API_VERSION', nil)
   self.environment = ENV.fetch('CRONITOR_ENVIRONMENT', nil)
-  self.timeout = ENV.fetch('CRONITOR_TIMEOUT', nil) || 10
-  self.ping_timeout = ENV.fetch('CRONITOR_PING_TIMEOUT', nil) || 5
+  self.timeout = ENV.fetch('CRONITOR_TIMEOUT', 10)
+  self.ping_timeout = ENV.fetch('CRONITOR_PING_TIMEOUT', 5)
   self.config = ENV.fetch('CRONITOR_CONFIG', nil)
   self.auto_discover_sidekiq = ENV.fetch('CRONITOR_AUTO_DISCOVER_SIDEKIQ', 'true').casecmp('true').zero? # https://github.com/cronitorio/cronitor-sidekiq
+  self.telemetry_domain = ENV.fetch('CRONITOR_TELEMETRY_DOMAIN', 'cronitor.link')
   self.logger = Logger.new($stdout)
   logger.level = Logger::INFO
 end

data/lib/cronitor/monitor.rb

@@ -4,7 +4,7 @@ module Cronitor
   class Monitor
     attr_reader :key, :api_key, :api_version, :env
 
-    PING_RETRY_THRESHOLD = 5
+    PING_RETRY_THRESHOLD = 3
 
     module Formats
       ALL = [
@@ -24,19 +24,19 @@ module Cronitor
                         })
     end
 
+
     def self.put(opts = {})
       rollback = opts[:rollback] || false
       opts.delete(:rollback)
 
       monitors = opts[:monitors] || [opts]
-
+      url = "https://cronitor.io/api/monitors"
       if opts[:format] == Cronitor::Monitor::Formats::YAML
-        url = "#{Cronitor.monitor_api_url}.yaml"
+        url = "#{url}.yaml"
         monitors['rollback'] = true if rollback
         body = YAML.dump(monitors)
         headers = Cronitor::Monitor::Headers::YAML
       else
-        url = Cronitor.monitor_api_url
         body = {
           monitors: monitors,
           rollback: rollback
@@ -120,8 +120,7 @@ module Cronitor
 
       begin
         ping_url = ping_api_url
-        ping_url = fallback_ping_api_url if retry_count > (PING_RETRY_THRESHOLD / 2)
-
+        ping_url = fallback_ping_api_url if retry_count > Monitor::PING_RETRY_THRESHOLD
         response = HTTParty.get(
           ping_url,
           query: clean_params(params),
@@ -159,7 +158,7 @@ module Cronitor
     end
 
     def pause(hours = nil)
-      pause_url = "#{monitor_api_url}/pause"
+      pause_url = "#{monitor_api_url}/#{key}/pause"
       pause_url += "/#{hours}" unless hours.nil?
 
       resp = HTTParty.get(
@@ -180,7 +179,7 @@ module Cronitor
     end
 
     def ping_api_url
-      "https://cronitor.link/p/#{api_key}/#{key}"
+      "https://#{Cronitor.telemetry_domain}/p/#{api_key}/#{key}"
     end
 
     def fallback_ping_api_url
@@ -188,9 +187,10 @@ module Cronitor
     end
 
     def monitor_api_url
-      "#{Cronitor.monitor_api_url}/#{key}"
+      "https://cronitor.io/api/monitors"
     end
 
+
     private
 
     def fetch

data/lib/cronitor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cronitor
-  VERSION = '5.1.0'
+  VERSION = '5.2.0'
 end

data/lib/cronitor.rb

@@ -63,9 +63,6 @@ module Cronitor
     end
   end
 
-  def self.monitor_api_url
-    'https://cronitor.io/api/monitors'
-  end
 end
 
 Cronitor.read_config(Cronitor.config) unless Cronitor.config.nil?

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: cronitor
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Jeff Byrnes
 - August Flanagan
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-14 00:00:00.000000000 Z
+date: 2024-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -165,7 +165,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-description:
+description: 
 email:
 - thejeffbyrnes@gmail.com
 - august@cronitor.io
@@ -194,7 +194,7 @@ files:
 homepage: https://github.com/cronitorio/cronitor-ruby
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -209,8 +209,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: An interface for the Cronitor API
 test_files: []