fde-slack-notification 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa529431a2cfe13fa1deedecf26504d6ab4c4034fed23024da208eed611c884e
-  data.tar.gz: 89917fc9336855d30bb4bf9dd90ca36708f4ed87f6543dcca0b14aca08a6b6ff
+  metadata.gz: a27394e5562d79819b179f8e001754ed59c49143450ac72f0dbc7751a3f90961
+  data.tar.gz: c1e22be84903957d0d8ab6582bd031a9e7d5b75a11041a14f6767971ed61db5f
 SHA512:
-  metadata.gz: 8fc84421fef8a53233937d406c0053138376398b6a659c7d12a7724edc7547e091de3de514706a9aa0735bec1886bcf1a5bed9e796ec04b84ccd0a2283982465
-  data.tar.gz: c54e6f661699731af42d7a0f4206433fd62d61fca85153a094f4e3df9477ee82b7a35d241258fa4fb0242d4f6ac695db3dc37fcc261aeba9219108636486aed1
+  metadata.gz: e5aca1edeaf43bfbb723c16c42bb9786945e6b5f6bbe216d0fdff8251842453aa8813453cd101f5f11bb266f1b3fcb5dc8c21bd5b6df34cd6a5a36aec586fb16
+  data.tar.gz: 9d78a00e0c8faec3653c1dc19ae5b5aedd835f46dee1cbbdc15e5e61df3bbe217c6d1d17b1a576b361a003a48ad6ae82d4746d74961abfc4c5d3bba34e151dbf

data/lib/slack/message.rb

@@ -9,6 +9,9 @@ module FDE
       YELLOW = '#FEEFB3'.freeze
       RED = '#FFBABA'.freeze
 
+      RETRY_LIMIT = 1
+      TOO_MANY_REQUESTS_STATUS_CODE = "429"
+
 
       attr_accessor :username,
         :title,
@@ -17,6 +20,8 @@ module FDE
         :footer,
         :color
 
+      attr_reader :retries
+
       def initialize(title, fields, options = {})
         @title = title
         @fields = fields
@@ -32,6 +37,8 @@ module FDE
         if options[:footer]
           @footer = options[:footer]
         end
+
+        @retries = 0
       end
 
       def deliver(channel, level: :info)
@@ -69,10 +76,22 @@ module FDE
           FDE::Slack::Notification.config.webhook,
           channel: channel,
           username: @username
-        )
+        ) do
+          # configure Slack Notifier gem to use our custom HTTPClient
+          # see https://github.com/stevenosloan/slack-notifier#custom-http-client
+          http_client FDE::Slack::Util::HTTPClient
+        end
+
         begin 
           notifier.ping message_hash
-        rescue ::Slack::Notifier::APIError
+        rescue FDE::Slack::APIError => api_error
+          # TooManyRequests, Slack Rate Limit
+          if api_error.response.code == TOO_MANY_REQUESTS_STATUS_CODE && @retries < RETRY_LIMIT
+            timeout = api_error.response.header['Retry-After'].to_i
+            sleep(timeout) if timeout
+            @retries += 1
+            retry
+          end
           raise FDE::Slack::Message::Error
         end
       end

data/lib/slack/notification.rb

@@ -5,6 +5,7 @@ require "slack/message"
 require "slack/field"
 require "slack/author"
 require "slack/footer"
+require "slack/util/http_client"
 
 module FDE
   module Slack

data/lib/slack/notification/version.rb

@@ -1,7 +1,7 @@
 module FDE
   module Slack
     module Notification
-      VERSION = "1.2.1"
+      VERSION = "1.3.1"
     end
   end
 end

data/lib/slack/util/http_client.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "net/http"
+
+# Custom HTTP Client to auto-retry once when Slack Rate Limit error is encountered.
+# The basis of this code is from https://github.com/stevenosloan/slack-notifier/blob/master/lib/slack-notifier/util/http_client.rb
+# The improved APIError code from https://github.com/stevenosloan/slack-notifier/pull/111
+# And the rate limit retry is custom
+module FDE
+  module Slack
+    class APIError < StandardError
+      attr_reader :response
+
+      def initialize(response)
+        @response = response
+      end
+
+      def message
+        <<-MSG
+The slack API returned an error with HTTP Code #{@response.code}
+Check the "Handling Errors" section on https://api.slack.com/incoming-webhooks for more information
+        MSG
+      end
+    end
+
+    module Util
+      class HTTPClient
+        class << self
+          def post uri, params
+            HTTPClient.new(uri, params).call
+          end
+        end
+
+        attr_reader :uri, :params, :http_options
+
+        def initialize uri, params
+          @uri          = uri
+          @http_options = params.delete(:http_options) || {}
+          @params       = params
+        end
+
+        def call
+          http_obj.request(request_obj).tap do |response|
+            unless response.is_a?(Net::HTTPSuccess)
+              raise FDE::Slack::APIError.new(response)
+            end
+          end
+        end
+
+        private
+
+        def request_obj
+          req = Net::HTTP::Post.new uri.request_uri
+          req.set_form_data params
+
+          req
+        end
+
+        def http_obj
+          http = Net::HTTP.new uri.host, uri.port
+          http.use_ssl = (uri.scheme == "https")
+
+          http_options.each do |opt, val|
+            if http.respond_to? "#{opt}="
+              http.send "#{opt}=", val
+            else
+              warn "Net::HTTP doesn't respond to `#{opt}=`, ignoring that option"
+            end
+          end
+
+          http
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fde-slack-notification
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.1
 platform: ruby
 authors:
 - Felix Langenegger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slack-notifier
@@ -104,20 +104,20 @@ dependencies:
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.3
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.3
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.3
 - !ruby/object:Gem::Dependency
@@ -206,6 +206,7 @@ files:
 - lib/slack/message.rb
 - lib/slack/notification.rb
 - lib/slack/notification/version.rb
+- lib/slack/util/http_client.rb
 homepage: ''
 licenses:
 - MIT
@@ -226,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A simple slack client