opsgenie-heartbeat 0.1.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 90ab82ef80b3460608df4482d3cfec7854abe08d
-  data.tar.gz: 860eef58b7f9ee13b7e4ed72734ac938987e878d
+SHA256:
+  metadata.gz: 40ad93c29a50145b21401962688273ffb38cd994bfd6d222d82ea43baeafaa5e
+  data.tar.gz: 055e1f4ab36b7d670ef8a85b9989f60a862833cd3085f0865c1997bd0950d6ac
 SHA512:
-  metadata.gz: dd2e2930a0a5b714580839cdf235f27794e2d52175a643dc08a564ef9cb960f5213d790fe982517158eb7d98d199318d90e2797cfc4734eae6385fdb38d056d8
-  data.tar.gz: 5d6dae499406c7c1f2e713c74ab8099e60059f6f55090ae48c251d5501c52b08ba417864a5e79315a1fa60c6246e0d8a81bc5ad314a873dc70712e1ffc0479c3
+  metadata.gz: 1b366b335612b50cf981e6be0e16f11be22cde7c6aa36804ab940451f4ddc443d025fd804011935b2ae4230f5e4879323a1f52bfeebe1ef305dd2435fbd5163f
+  data.tar.gz: bd62e408cda81d65e689e28bbc2b6f109f761cab3e29e398a1d5dd1f7df137b3a46a9729777197a284bed2c5e4a18b78c4f2e8540c8830119d7c54e8e022cc6e

data/.rspec

@@ -1,3 +1,2 @@
 --format documentation
 --color
---warnings

data/CHANGELOG.md

@@ -1,7 +1,24 @@
-Updates in version 0.1.1:
+## Updates in version 0.4:
+- ability to configure retries
 
-  No need to supply name_transformer in initializer file unless wanted.
-  Now there is default value -> name itself.
+## Updates in version 0.3:
+- ability to configure a default team
 
-Updates in version 0.1.2:
-  Instead of require 'opsgenie/heartbeat/heartbeat' now is require 'opsgenie/heartbeat'
+## Updates in version 0.2.1:
+- fix ensure always trying to create heartbeat
+- use get instead of post for pinging
+
+## Updates in version 0.2.0:
+
+- Allow updating of heartbeats
+- Allow setting of team
+
+
+##Updates in version 0.1.2:
+
+- Instead of require 'opsgenie/heartbeat/heartbeat' now is require 'opsgenie/heartbeat'
+
+## Updates in version 0.1.1:
+
+- No need to supply name_transformer in initializer file unless wanted.
+- Now there is default value -> name itself.

data/README.md

@@ -49,6 +49,14 @@ In yours initializers folder, define new file with:
     # - if config.raise_error = true is set then it raises error
     # - if nothing is defined, then it ignores error
     config.logger = Rails.logger
+
+    #will set the team to Myteam on all new heartbeats
+    #you can override when you create the heartbeat.
+    config.default_team = 'Myteam'
+
+    #retry timedout api calls upto the specified number of times, with a random backoff
+    #default is no retries
+    config.retries = 2
   end
   ```
 

data/lib/opsgenie/heartbeat/config.rb

@@ -9,7 +9,7 @@ module Opsgenie
     end
 
     class Config
-      attr_accessor :enabled, :api_key, :name_transformer, :logger, :raise_error
+      attr_accessor :enabled, :api_key, :name_transformer, :logger, :raise_error, :default_team, :retries
 
       def name_transformer
         @name_transformer || ->(name){name}

data/lib/opsgenie/heartbeat/version.rb

@@ -1,5 +1,5 @@
 module Opsgenie
   module Heartbeat
-    VERSION = "0.1.2"
+    VERSION = "0.4.0"
   end
 end

data/lib/opsgenie/heartbeat.rb

@@ -6,75 +6,131 @@ require 'rack'
 
 module Opsgenie
   module Heartbeat
+    class << self
+      def pulse(name)
+        return unless configuration.enabled
+        name = configuration.name_transformer.call(name)
+        begin
+          uri = URI.parse("https://api.opsgenie.com/v2/heartbeats/#{Rack::Utils.escape name}/ping")
+          with_timeout_retries do
+            http = Net::HTTP.new(uri.host, uri.port)
+            http.use_ssl = true
+            response = http.get(uri.path, {'Authorization': "GenieKey #{configuration.api_key}"})
+            if !response.is_a?(Net::HTTPSuccess)
+              configuration.logger.info("Error creating or updating heartbeat: #{response}") if configuration.logger
+            end
+          end
+        rescue => e
+          resolve_exception e
+        end
+      end
+
+      def ensure(name:, interval:, unit: , description:, enabled: true, team: nil)
+        return unless configuration.enabled
+        original_name = name
+        name =  configuration.name_transformer.call(name)
 
-    def self.pulse(name)
-      return unless configuration.enabled
-      name = configuration.name_transformer.call(name)
-      begin
-        uri = URI.parse("https://api.opsgenie.com/v2/heartbeats/#{Rack::Utils.escape name}/ping")
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = true
-        data = {name: name}
-        http.post(uri.path, data.to_json, {'Authorization': "GenieKey #{configuration.api_key}", "Content-Type": "application/json"})
-      rescue => e
-        resolve_exception e
+        uri = URI.parse(url_for_resource(:get, name))
+        with_timeout_retries do
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = true
+          response = http.get(uri.path, {'Authorization': "GenieKey #{configuration.api_key}"})
+          unless response.is_a?(Net::HTTPSuccess)
+            create(name: original_name, description: description, interval: interval, unit: unit, enabled: enabled, team: team)
+          end
+        end
       end
-    end
 
-    def self.ensure(name:, interval:, unit: , description:, enabled: true)
-      return unless configuration.enabled
-      original_name = name
-      name =  configuration.name_transformer.call(name)
-
-      uri = URI.parse("https://api.opsgenie.com/v2/heartbeats/#{Rack::Utils.escape name}")
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
-      response = http.get(uri.path)
-      unless response.is_a?(Net::HTTPSuccess)
-        create(name: original_name, description: description, interval: interval, unit: unit, enabled: enabled)
+      def delete(name)
+        return unless configuration.enabled
+        name = configuration.name_transformer.call(name)
+
+        begin
+          uri = URI.parse(url_for_resource(:delete, name))
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = true
+
+          http.delete(uri.path, {'Authorization': "GenieKey #{configuration.api_key}", "Content-Type": "application/json"})
+        rescue => e
+          resolve_exception e
+        end
+      end
+
+      def update(name:, interval: nil, unit: nil, description: nil, enabled: nil, team: nil)
+        return unless configuration.enabled
+        create_or_update(:patch, name: name, description: description, interval: interval, unit: unit, enabled: enabled, team: team)
+      end
+
+      def create(name:, interval: nil, unit: nil, description: nil, enabled: nil, team: nil)
+        return unless configuration.enabled
+        create_or_update(:post, name: name, description: description, interval: interval, unit: unit, enabled: enabled, team: team)
       end
-    end
 
-    def self.delete(name)
-      return unless configuration.enabled
-      name = configuration.name_transformer.call(name)
 
-      begin
-        uri = URI.parse("https://api.opsgenie.com/v2/heartbeats/#{Rack::Utils.escape name}")
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = true
+      private
 
-        http.delete(uri.path, {'Authorization': "GenieKey #{configuration.api_key}", "Content-Type": "application/json"})
-      rescue => e
-        resolve_exception e
+      def with_timeout_retries
+        attempts = 0
+        begin
+          yield
+        rescue Net::OpenTimeout, Net::ReadTimeout => e
+          if attempts < (configuration.retries || 0)
+            configuration.logger.info("Retrying opsgenie api call after timeout #{e.message}")
+            attempts += 1
+            sleep(rand(2**attempts))
+            retry
+          else
+            raise
+          end
+        end
       end
-    end
 
-    private
-
-    def self.create(name:,description:,interval:,unit:, enabled:)
-      name = configuration.name_transformer.call(name)
-
-      begin
-        uri = URI.parse('https://api.opsgenie.com/v2/heartbeats')
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = true
-        doc = {
-          name: name,
-          description: description,
-          interval: interval,
-          intervalUnit: unit,
-          enabled: enabled
-        }
-        http.post(uri.path, doc.to_json, {'Authorization': "GenieKey #{configuration.api_key}", "Content-Type": "application/json"})
-      rescue => e
-        resolve_exception e
+
+
+      def url_for_resource(verb, name)
+        if verb == :post
+          'https://api.opsgenie.com/v2/heartbeats'
+        else
+          "https://api.opsgenie.com/v2/heartbeats/#{Rack::Utils.escape name}"
+        end
       end
-    end
 
-    def self.resolve_exception e
-      configuration.logger.info("Exception raised during heartbeat: #{e.message} #{e.backtrace}") if configuration.logger
-      raise if configuration.raise_error
+      def create_or_update(verb, name:,description:,interval:,unit:, enabled:, team:)
+        name = configuration.name_transformer.call(name)
+
+        begin
+          uri = URI.parse(url_for_resource(verb, name))
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = true
+          team_to_assign = case team
+          when nil then configuration.default_team
+          when false then nil
+          else
+            team
+          end
+          doc = {
+            name: name,
+            description: description,
+            interval: interval,
+            intervalUnit: unit,
+            enabled: enabled,
+            ownerTeam: team_to_assign
+          }.reject {|_, value| value.nil?}
+          response = http.public_send(verb, uri.path, doc.to_json, {'Authorization': "GenieKey #{configuration.api_key}", "Content-Type": "application/json"})
+
+          if !response.is_a?(Net::HTTPSuccess)
+            configuration.logger.info("Error creating or updating heartbeat: #{response}") if configuration.logger
+          end
+
+        rescue => e
+          resolve_exception e
+        end
+      end
+
+      def resolve_exception e
+        configuration.logger.info("Exception raised during heartbeat: #{e.message} #{e.backtrace}") if configuration.logger
+        raise if configuration.raise_error
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opsgenie-heartbeat
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Dressipi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-07 00:00:00.000000000 Z
+date: 2018-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: OpsGenie Heartbeat version 2