fluent-plugin-zulip 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00ee9b9a084c766087bdbd39e526609e8bc9a348
-  data.tar.gz: 74f53fce8658e49708dfcfa51853a670efc47e4a
+  metadata.gz: 8c492b2c2284d81f89494a2f8627b269fba06772
+  data.tar.gz: 2e4034d94b629adc71b551ed062a1d048c0512a1
 SHA512:
-  metadata.gz: 4322e7f1145079b9bd403c302ec99857250cfc967853a35cce1eb51e64feb667e4420defda34765b74c0088fb75ed6da15f85d411566b89898dff3526317505b
-  data.tar.gz: f7988326dc364573f53b190d26623a9e0753230fc6b39f2f77c2c065ebd30083e716d221a0fd5ccff78e87afdc77856c90180a2588afd636404652ad815a6861
+  metadata.gz: 4c34389a79c8e7f34d9e7aaba5e9e9bc2c2cd531f0c57c4df92012f0545e07ea6e7c159c9dd3c731c8fa6f4ebc835035521840eaf296424ea0f400cef76493cd
+  data.tar.gz: 0d38b190a61dab04421b7bcdf590edbfd0fb2550296ffb642f1b8f447f89a281c44b2368ac8b5ac188c967775de0daf2249341fe3212eb6415bc168df515796a

data/README.md

@@ -4,6 +4,15 @@
 
 [Zulip](https://zulip.org/) is a powerful open source group chat.
 
+## Requirements
+
+| fluent-plugin-zulip | fluentd    | ruby   |
+|---------------------|------------|--------|
+| >= 0.1.0            | >= v0.14.0 | >= 2.1 |
+| N/A                 | >= v0.12.0 | >= 1.9 |
+
+NOTE: fluent-plugin-zulip doesn't support Fluentd v0.12.x
+
 ## Installation
 
 ### RubyGems

data/fluent-plugin-zulip.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name    = "fluent-plugin-zulip"
-  spec.version = "0.1.0"
+  spec.version = "0.2.0"
   spec.authors = ["Kenji Okimoto"]
   spec.email   = ["okimoto@clear-code.com"]
 
@@ -24,5 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "test-unit"
   spec.add_development_dependency "webmock"
-  spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
+  spec.add_runtime_dependency "fluentd", ">= 0.14.10", "< 2"
+  spec.add_runtime_dependency "zulip-client", ">= 0.2.0"
 end

data/lib/fluent/plugin/out_zulip.rb

@@ -14,7 +14,7 @@
 
 require "fluent/plugin/output"
 require "json"
-require "net/http"
+require "zulip/client"
 
 module Fluent
   module Plugin
@@ -25,7 +25,7 @@ module Fluent
       ZULIP_CONTENT_MAX_SIZE = 10000
 
       desc "API endpoint"
-      config_param :api_endpoint, :string
+      config_param :site, :string
       desc "Bot email address"
       config_param :bot_email_address, :string
       desc "Bot API key"
@@ -61,46 +61,38 @@ module Fluent
           raise Fluent::ConfigError, "subject max length is #{ZULIP_SUBJECT_MAX_SIZE}"
         end
 
-        @api_endpoint_uri = URI.parse(@api_endpoint)
+        @client = Zulip::Client.new(site: @site,
+                                    username: @bot_email_address,
+                                    api_key: @bot_api_key)
       end
 
       def process(tag, es)
-        http = Net::HTTP.new(@api_endpoint_uri.host, @api_endpoint_uri.port)
-        http.use_ssl = @api_endpoint_uri.scheme == "https"
-        http.start
         es.each do |time, record|
-          request = build_request(tag, time, record)
-          response = http.request(request)
-          case response
-          when Net::HTTPSuccess
+          response = send_message(tag, time, record)
+          if response.success?
             log.info(response.body)
-          when Net::HTTPServerError, Net::HTTPClientError
-            log.error(status: response.code, body: response.body)
           else
-            log.warn(status: response.code, body: response.body)
+            log.error(status: response.status,
+                      message: response.reason_phrase,
+                      body: response.body)
           end
           log.debug(response)
         end
-        http.finish
       end
 
-      def build_request(tag, time, record)
-        request = Net::HTTP::Post.new(@api_endpoint_uri.path)
-        request.basic_auth(@bot_email_address, @bot_api_key)
-        request["Connection"] = "Keep-Alive"
-        params = {
-          "type" => @message_type,
-          "content" => record[@content_key]
-        }
+      def send_message(tag, time, record)
         case @message_type
-        when :private
-          params["to"] = JSON.generate(@recipients)
         when :stream
-          params["to"] = @stream_name
-          params["subject"] = @subject || record[@subject_key]
+          to = @stream_name
+          subject = @subject || record[@subject_key]
+          @client.send_public_message(to: to,
+                                      subject: subject,
+                                      content: record[@content_key])
+        when :private
+          to = @recipients
+          @client.send_private_message(to: to,
+                                       content: record[@content_key])
         end
-        request.set_form_data(params, ";")
-        request
       end
     end
   end

data/test/plugin/test_out_zulip.rb

@@ -11,7 +11,7 @@ class ZulipOutputTest < Test::Unit::TestCase
   end
 
   CONF = config_element("ROOT", "", {
-                          "api_endpoint" => "https://zulip.example.com/api/v1/messages",
+                          "site" => "https://zulip.example.com/",
                           "bot_email_address" => "example-bot@example.com",
                           "bot_api_key" => "very-secret-value",
                         })
@@ -26,12 +26,12 @@ class ZulipOutputTest < Test::Unit::TestCase
     test "minimal" do
       d = create_driver(CONF)
       actual = {
-        api_endpoint: d.instance.api_endpoint,
+        site: d.instance.site,
         bot_email_address: d.instance.bot_email_address,
         bot_api_key: d.instance.bot_api_key
       }
       expected = {
-        api_endpoint: "https://zulip.example.com/api/v1/messages",
+        site: "https://zulip.example.com/",
         bot_email_address: "example-bot@example.com",
         bot_api_key: "very-secret-value",
       }
@@ -65,16 +65,14 @@ class ZulipOutputTest < Test::Unit::TestCase
       d = create_driver(CONF)
       record = { message: "This is test message" }
       headers = {
-        "Connection" => "Keep-Alive",
-        "Accept" => "*/*",
-        "Accept-Encoding" => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
-        "Content-Type" => "application/x-www-form-urlencoded",
-        "User-Agent" => "Ruby"
+        "Authorization" => "Basic ZXhhbXBsZS1ib3RAZXhhbXBsZS5jb206dmVyeS1zZWNyZXQtdmFsdWU=",
+        "Expect" => "",
+        "User-Agent" => "Faraday v0.12.0.1"
       }
       stub_request(:post, "https://zulip.example.com/api/v1/messages")
         .with(basic_auth: ["example-bot@example.com", "very-secret-value"],
               headers: headers,
-              body: "type=stream;content;to=social;subject")
+              body: "content&subject&to=social&type=stream")
         .to_return(headers: {},
                    body: { message: "", result: "success", id: 1234 }.to_json)
       d.run(default_tag: "test") do
@@ -89,16 +87,14 @@ class ZulipOutputTest < Test::Unit::TestCase
       d = create_driver(CONF)
       record = { message: "This is test message" }
       headers = {
-        "Connection" => "Keep-Alive",
-        "Accept" => "*/*",
-        "Accept-Encoding" => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
-        "Content-Type" => "application/x-www-form-urlencoded",
-        "User-Agent" => "Ruby"
+        "Authorization" => "Basic ZXhhbXBsZS1ib3RAZXhhbXBsZS5jb206dmVyeS1zZWNyZXQtdmFsdWU=",
+        "Expect" => "",
+        "User-Agent" => "Faraday v0.12.0.1"
       }
       stub_request(:post, "https://zulip.example.com/api/v1/messages")
         .with(basic_auth: ["example-bot@example.com", "very-secret-value"],
               headers: headers,
-              body: "type=stream;content;to=social;subject")
+              body: "content&subject&to=social&type=stream")
         .to_return(status: 500,
                    headers: {},
                    body: { message: "", result: "failure" }.to_json)
@@ -106,8 +102,9 @@ class ZulipOutputTest < Test::Unit::TestCase
         d.feed(event_time, record)
       end
       line = d.logs.first
+      puts line
       message = line[/(\[error\]:  status=.+ body=.+)/, 1]
-      assert_equal(%q([error]:  status="500" body="{\\"message\\":\\"\\",\\"result\\":\\"failure\\"}"), message)
+      assert_equal(%q([error]:  status=500 message=nil body="{\\"message\\":\\"\\",\\"result\\":\\"failure\\"}"), message)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-zulip
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kenji Okimoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-30 00:00:00.000000000 Z
+date: 2017-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,6 +86,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: zulip-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 description: Fluentd output plugin for Zulip powerful open source group chat.
 email:
 - okimoto@clear-code.com
@@ -122,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Fluentd output plugin for Zulip powerful open source group chat.