fluent-plugin-slack 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 401cd80a470edd2acf64f3530ee125df42fa9393
-  data.tar.gz: 3c4238b53bf9ded7336eaf4148e572f1b18a9cc9
+  metadata.gz: abca37bc729bcbae33c6550af3a6a271f979e70d
+  data.tar.gz: d7124e7eed5b0c920bdf0125324683668ff938b2
 SHA512:
-  metadata.gz: bd6b4662dfe23aefb7ebaf856b413e025d09ff0efa43ad75cd764129024a055ac280dfb32d94f5d2771e5d721e4c23d2163fb125776ee4e520f945019b1c017b
-  data.tar.gz: be176edc0387bc6848214744931250aff8b38078ba2b4cd0ac1f7a086b81919b26237d5de446dcd85230a03c0fea4424ff72c0a63aa8117ee35a36227b9d962f
+  metadata.gz: b7380082aca202039dee0eef3c69a4c6ee80752245be769c182de7e35dc994967b960c4555cd5658d4b93a53aa5f412d5a75e8f2a8288835a1e7f1f867fc8f49
+  data.tar.gz: c73f180c32d084c5d7d91434b56a94b189ec19722327d7008a406abe5825eb507be84c2c3e149db86640cfce083e56a4001c07534418796b8e541c6e46105e01

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.6.5 (2017/05/20)
+
+Enhancements:
+
+* Avoid Encoding::UndefinedConversionError from ASCII-8BIT to UTF-8 on to_json by doing String#scrub! (thanks @yoheimuta)
+
 ## 0.6.4 (2016/07/07)
 
 Enhancements:

data/VERSION

@@ -1 +1 @@
-0.6.4
+0.6.5

data/lib/fluent/plugin/out_buffered_slack.rb

@@ -1 +1 @@
-out_slack.rb
+lib/fluent/plugin/out_slack.rb

data/lib/fluent/plugin/slack_client.rb

@@ -97,6 +97,35 @@ module Fluent
           end
         end
       end
+
+      def to_json_with_scrub!(params)
+        retries = 1
+        begin
+          params.to_json
+        rescue Encoding::UndefinedConversionError => e
+          recursive_scrub!(params)
+          if (retries -= 1) >= 0 # one time retry
+            log.warn "out_slack: to_json `#{params}` failed. retry after scrub!. #{e.message}"
+            retry
+          else
+            raise e
+          end
+        end
+      end
+
+      def recursive_scrub!(params)
+        case params
+        when Hash
+          params.each {|k, v| recursive_scrub!(v)}
+        when Array
+          params.each {|elm| recursive_scrub!(elm)}
+        when String
+          params.force_encoding(Encoding::UTF_8) if params.encoding == Encoding::ASCII_8BIT
+          params.scrub!('?') if params.respond_to?(:scrub!)
+        else
+          params
+        end
+      end
     end
 
     # Slack client for Incoming Webhook
@@ -115,7 +144,7 @@ module Fluent
 
       def encode_body(params = {})
         # https://api.slack.com/docs/formatting
-        params.to_json.gsub(/&/, '&amp;').gsub(/</, '&lt;').gsub(/>/, '&gt;')
+        to_json_with_scrub!(params).gsub(/&/, '&amp;').gsub(/</, '&lt;').gsub(/>/, '&gt;')
       end
 
       def response_check(res, params)
@@ -237,7 +266,7 @@ module Fluent
       def encode_body(params = {})
         body = params.dup
         if params[:attachments]
-          body[:attachments] = params[:attachments].to_json
+          body[:attachments] = to_json_with_scrub!(params[:attachments])
         end
         URI.encode_www_form(body)
       end

data/test/plugin/test_slack_client.rb

@@ -92,6 +92,15 @@ if ENV['WEBHOOK_URL'] and ENV['SLACKBOT_URL'] and ENV['SLACK_API_TOKEN']
       }
     end
 
+    def valid_utf8_encoded_string
+      "#general \xE3\x82\xA4\xE3\x83\xB3\xE3\x82\xB9\xE3\x83\x88\xE3\x83\xBC\xE3\x83\xAB\n"
+    end
+
+    def invalid_ascii8bit_encoded_utf8_string
+      str = "#general \xE3\x82\xA4\xE3\x83\xB3\xE3\x82\xB9\xE3\x83\x88\xE3\x83\xBC\xE3\x83\xAB\x81\n"
+      str.force_encoding(Encoding::ASCII_8BIT)
+    end
+
     # Notification via Mention works for all three with plain text payload
     def test_post_message_plain_payload_mention
       [@incoming, @slackbot, @api].each do |slack|
@@ -232,5 +241,42 @@ if ENV['WEBHOOK_URL'] and ENV['SLACKBOT_URL'] and ENV['SLACK_API_TOKEN']
         )
       end
     end
+
+    # IncomingWebhook posts "#general インストール"
+    def test_post_message_utf8_encoded_text
+      [@incoming].each do |slack|
+        assert_nothing_raised do
+          slack.post_message(default_payload(slack).merge({
+            text: valid_utf8_encoded_string,
+          }))
+        end
+      end
+    end
+
+    # IncomingWebhook posts "#general インストール?"
+    def test_post_message_ascii8bit_encoded_utf8_text
+      [@incoming].each do |slack|
+        assert_nothing_raised do
+          slack.post_message(default_payload(slack).merge({
+            text: invalid_ascii8bit_encoded_utf8_string,
+          }))
+        end
+      end
+    end
+
+    # IncomingWebhook and API posts "#general インストール?"
+    def test_post_message_ascii8bit_encoded_utf8_attachments
+      [@incoming, @api].each do |slack|
+        assert_nothing_raised do
+          slack.post_message(default_payload(slack).merge({
+            attachments: [default_attachment.merge({
+              color:    'good',
+              fallback: invalid_ascii8bit_encoded_utf8_string,
+              text:     invalid_ascii8bit_encoded_utf8_string,
+            })]
+          }))
+        end
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-slack
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - Keisuke SOGAWA
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-07 00:00:00.000000000 Z
+date: 2017-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -169,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: fluent Slack plugin