fluent-plugin-zulip 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +51 -0
- data/Gemfile +5 -0
- data/LICENSE +202 -0
- data/README.md +69 -0
- data/Rakefile +13 -0
- data/fluent-plugin-zulip.gemspec +28 -0
- data/lib/fluent/plugin/out_zulip.rb +107 -0
- data/test/helper.rb +9 -0
- data/test/plugin/test_out_zulip.rb +113 -0
- metadata +131 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 00ee9b9a084c766087bdbd39e526609e8bc9a348
|
4
|
+
data.tar.gz: 74f53fce8658e49708dfcfa51853a670efc47e4a
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 4322e7f1145079b9bd403c302ec99857250cfc967853a35cce1eb51e64feb667e4420defda34765b74c0088fb75ed6da15f85d411566b89898dff3526317505b
|
7
|
+
data.tar.gz: f7988326dc364573f53b190d26623a9e0753230fc6b39f2f77c2c065ebd30083e716d221a0fd5ccff78e87afdc77856c90180a2588afd636404652ad815a6861
|
data/.gitignore
ADDED
@@ -0,0 +1,51 @@
|
|
1
|
+
*.gem
|
2
|
+
*.rbc
|
3
|
+
/.config
|
4
|
+
/coverage/
|
5
|
+
/InstalledFiles
|
6
|
+
/pkg/
|
7
|
+
/spec/reports/
|
8
|
+
/spec/examples.txt
|
9
|
+
/test/tmp/
|
10
|
+
/test/version_tmp/
|
11
|
+
/tmp/
|
12
|
+
|
13
|
+
# Used by dotenv library to load environment variables.
|
14
|
+
# .env
|
15
|
+
|
16
|
+
## Specific to RubyMotion:
|
17
|
+
.dat*
|
18
|
+
.repl_history
|
19
|
+
build/
|
20
|
+
*.bridgesupport
|
21
|
+
build-iPhoneOS/
|
22
|
+
build-iPhoneSimulator/
|
23
|
+
|
24
|
+
## Specific to RubyMotion (use of CocoaPods):
|
25
|
+
#
|
26
|
+
# We recommend against adding the Pods directory to your .gitignore. However
|
27
|
+
# you should judge for yourself, the pros and cons are mentioned at:
|
28
|
+
# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
|
29
|
+
#
|
30
|
+
# vendor/Pods/
|
31
|
+
|
32
|
+
## Documentation cache and generated files:
|
33
|
+
/.yardoc/
|
34
|
+
/_yardoc/
|
35
|
+
/doc/
|
36
|
+
/rdoc/
|
37
|
+
|
38
|
+
## Environment normalization:
|
39
|
+
/.bundle/
|
40
|
+
/vendor/bundle
|
41
|
+
/lib/bundler/man/
|
42
|
+
|
43
|
+
# for a library or gem, you might want to ignore these files since the code is
|
44
|
+
# intended to run in multiple environments; otherwise, check them in:
|
45
|
+
# Gemfile.lock
|
46
|
+
# .ruby-version
|
47
|
+
# .ruby-gemset
|
48
|
+
|
49
|
+
# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
|
50
|
+
.rvmrc
|
51
|
+
/Gemfile.lock
|
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,69 @@
|
|
1
|
+
# fluent-plugin-zulip
|
2
|
+
|
3
|
+
[Fluentd](http://fluentd.org/) output plugin to post messages to Zulip chat application.
|
4
|
+
|
5
|
+
[Zulip](https://zulip.org/) is a powerful open source group chat.
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
### RubyGems
|
10
|
+
|
11
|
+
```
|
12
|
+
$ gem install fluent-plugin-zulip
|
13
|
+
```
|
14
|
+
|
15
|
+
### Bundler
|
16
|
+
|
17
|
+
Add following line to your Gemfile:
|
18
|
+
|
19
|
+
```
|
20
|
+
gem "fluent-plugin-zulip"
|
21
|
+
```
|
22
|
+
|
23
|
+
And then execute:
|
24
|
+
|
25
|
+
```
|
26
|
+
$ bundle
|
27
|
+
```
|
28
|
+
|
29
|
+
## Configuration
|
30
|
+
|
31
|
+
* See also: Fluent::Plugin::Output
|
32
|
+
|
33
|
+
```aconf
|
34
|
+
<source>
|
35
|
+
@type dummy
|
36
|
+
dummy { "message": "This is a message" }
|
37
|
+
tag dummy.log
|
38
|
+
</source>
|
39
|
+
|
40
|
+
<match **>
|
41
|
+
@type zulip
|
42
|
+
api_endpoint https://zulip.example.com/api/v1/messages
|
43
|
+
bot_email_address test-bot@example.com
|
44
|
+
bot_api_key xxxxxxxxxxxxxxxxxxxxxxxxxx
|
45
|
+
</match>
|
46
|
+
```
|
47
|
+
|
48
|
+
## Fluent::Plugin::ZulipOutput
|
49
|
+
|
50
|
+
* **api_endpoint** (string) (required): API endpoint
|
51
|
+
* **bot_email_address** (string) (required): Bot email address
|
52
|
+
* **bot_api_key** (string) (required): Bot API key
|
53
|
+
* **message_type** (enum) (optional): Send message type
|
54
|
+
* Available values: private, stream
|
55
|
+
* Default value: `stream`.
|
56
|
+
* **stream_name** (string) (optional): Target stream name
|
57
|
+
* Default value: `social`.
|
58
|
+
* **recipients** (array) (optional): User names (email address) of the recipients for private message
|
59
|
+
* Default value: `[]`.
|
60
|
+
* **subject** (string) (optional): Topic subject
|
61
|
+
* **subject_key** (string) (optional): Topic subject from record
|
62
|
+
* **content_key** (string) (optional): Content from record
|
63
|
+
* Default value: `message`.
|
64
|
+
|
65
|
+
## Copyright
|
66
|
+
|
67
|
+
* Copyright(c) 2017- Kenji Okimoto
|
68
|
+
* License
|
69
|
+
* Apache License, Version 2.0
|
data/Rakefile
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
require "bundler"
|
2
|
+
Bundler::GemHelper.install_tasks
|
3
|
+
|
4
|
+
require "rake/testtask"
|
5
|
+
|
6
|
+
Rake::TestTask.new(:test) do |t|
|
7
|
+
t.libs.push("lib", "test")
|
8
|
+
t.test_files = FileList["test/**/test_*.rb"]
|
9
|
+
t.verbose = true
|
10
|
+
t.warning = true
|
11
|
+
end
|
12
|
+
|
13
|
+
task default: [:test]
|
@@ -0,0 +1,28 @@
|
|
1
|
+
lib = File.expand_path("../lib", __FILE__)
|
2
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
3
|
+
|
4
|
+
Gem::Specification.new do |spec|
|
5
|
+
spec.name = "fluent-plugin-zulip"
|
6
|
+
spec.version = "0.1.0"
|
7
|
+
spec.authors = ["Kenji Okimoto"]
|
8
|
+
spec.email = ["okimoto@clear-code.com"]
|
9
|
+
|
10
|
+
spec.summary = %q{Fluentd output plugin for Zulip powerful open source group chat.}
|
11
|
+
spec.description = %q{Fluentd output plugin for Zulip powerful open source group chat.}
|
12
|
+
spec.homepage = "https://github.com/fluent-plugins-nursery/fluent-plugin-zulip"
|
13
|
+
spec.license = "Apache-2.0"
|
14
|
+
|
15
|
+
test_files, files = `git ls-files -z`.split("\x0").partition do |f|
|
16
|
+
f.match(%r{^(test|spec|features)/})
|
17
|
+
end
|
18
|
+
spec.files = files
|
19
|
+
spec.executables = files.grep(%r{^bin/}) { |f| File.basename(f) }
|
20
|
+
spec.test_files = test_files
|
21
|
+
spec.require_paths = ["lib"]
|
22
|
+
|
23
|
+
spec.add_development_dependency "bundler"
|
24
|
+
spec.add_development_dependency "rake"
|
25
|
+
spec.add_development_dependency "test-unit"
|
26
|
+
spec.add_development_dependency "webmock"
|
27
|
+
spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
|
28
|
+
end
|
@@ -0,0 +1,107 @@
|
|
1
|
+
# Copyright 2017- Kenji Okimoto
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require "fluent/plugin/output"
|
16
|
+
require "json"
|
17
|
+
require "net/http"
|
18
|
+
|
19
|
+
module Fluent
|
20
|
+
module Plugin
|
21
|
+
class ZulipOutput < Fluent::Plugin::Output
|
22
|
+
Fluent::Plugin.register_output("zulip", self)
|
23
|
+
|
24
|
+
ZULIP_SUBJECT_MAX_SIZE = 60
|
25
|
+
ZULIP_CONTENT_MAX_SIZE = 10000
|
26
|
+
|
27
|
+
desc "API endpoint"
|
28
|
+
config_param :api_endpoint, :string
|
29
|
+
desc "Bot email address"
|
30
|
+
config_param :bot_email_address, :string
|
31
|
+
desc "Bot API key"
|
32
|
+
config_param :bot_api_key, :string, secret: true
|
33
|
+
desc "Send message type"
|
34
|
+
config_param :message_type, :enum, list: [:private, :stream], default: :stream
|
35
|
+
desc "Target stream name"
|
36
|
+
config_param :stream_name, :string, default: "social"
|
37
|
+
desc "User names (email address) of the recipients for private message"
|
38
|
+
config_param :recipients, :array, default: []
|
39
|
+
desc "Topic subject"
|
40
|
+
config_param :subject, :string, default: nil
|
41
|
+
desc "Topic subject from record"
|
42
|
+
config_param :subject_key, :string, default: nil
|
43
|
+
desc "Content from record"
|
44
|
+
config_param :content_key, :string, default: "message"
|
45
|
+
|
46
|
+
def configure(conf)
|
47
|
+
super
|
48
|
+
|
49
|
+
case @message_type
|
50
|
+
when :private
|
51
|
+
raise Fluent::ConfigError, "recipients are required when private message" if @recipients.empty?
|
52
|
+
when :stream
|
53
|
+
raise Fluent::ConfigError, "stream_name is required when stream message" unless @stream_name
|
54
|
+
end
|
55
|
+
|
56
|
+
if @subject && @subject_key
|
57
|
+
raise Fluent::ConfigError, "subject and subject_key are exclusive with each other"
|
58
|
+
end
|
59
|
+
|
60
|
+
if @subject && @subject.bytesize > ZULIP_SUBJECT_MAX_SIZE
|
61
|
+
raise Fluent::ConfigError, "subject max length is #{ZULIP_SUBJECT_MAX_SIZE}"
|
62
|
+
end
|
63
|
+
|
64
|
+
@api_endpoint_uri = URI.parse(@api_endpoint)
|
65
|
+
end
|
66
|
+
|
67
|
+
def process(tag, es)
|
68
|
+
http = Net::HTTP.new(@api_endpoint_uri.host, @api_endpoint_uri.port)
|
69
|
+
http.use_ssl = @api_endpoint_uri.scheme == "https"
|
70
|
+
http.start
|
71
|
+
es.each do |time, record|
|
72
|
+
request = build_request(tag, time, record)
|
73
|
+
response = http.request(request)
|
74
|
+
case response
|
75
|
+
when Net::HTTPSuccess
|
76
|
+
log.info(response.body)
|
77
|
+
when Net::HTTPServerError, Net::HTTPClientError
|
78
|
+
log.error(status: response.code, body: response.body)
|
79
|
+
else
|
80
|
+
log.warn(status: response.code, body: response.body)
|
81
|
+
end
|
82
|
+
log.debug(response)
|
83
|
+
end
|
84
|
+
http.finish
|
85
|
+
end
|
86
|
+
|
87
|
+
def build_request(tag, time, record)
|
88
|
+
request = Net::HTTP::Post.new(@api_endpoint_uri.path)
|
89
|
+
request.basic_auth(@bot_email_address, @bot_api_key)
|
90
|
+
request["Connection"] = "Keep-Alive"
|
91
|
+
params = {
|
92
|
+
"type" => @message_type,
|
93
|
+
"content" => record[@content_key]
|
94
|
+
}
|
95
|
+
case @message_type
|
96
|
+
when :private
|
97
|
+
params["to"] = JSON.generate(@recipients)
|
98
|
+
when :stream
|
99
|
+
params["to"] = @stream_name
|
100
|
+
params["subject"] = @subject || record[@subject_key]
|
101
|
+
end
|
102
|
+
request.set_form_data(params, ";")
|
103
|
+
request
|
104
|
+
end
|
105
|
+
end
|
106
|
+
end
|
107
|
+
end
|
data/test/helper.rb
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
$LOAD_PATH.unshift(File.expand_path("../../", __FILE__))
|
2
|
+
require "test-unit"
|
3
|
+
require "fluent/test"
|
4
|
+
require "fluent/test/driver/output"
|
5
|
+
require "fluent/test/helpers"
|
6
|
+
require "webmock/test_unit"
|
7
|
+
|
8
|
+
Test::Unit::TestCase.include(Fluent::Test::Helpers)
|
9
|
+
Test::Unit::TestCase.extend(Fluent::Test::Helpers)
|
@@ -0,0 +1,113 @@
|
|
1
|
+
require "helper"
|
2
|
+
require "fluent/plugin/out_zulip.rb"
|
3
|
+
|
4
|
+
class ZulipOutputTest < Test::Unit::TestCase
|
5
|
+
def setup
|
6
|
+
Fluent::Test.setup
|
7
|
+
end
|
8
|
+
|
9
|
+
def create_driver(conf)
|
10
|
+
Fluent::Test::Driver::Output.new(Fluent::Plugin::ZulipOutput).configure(conf)
|
11
|
+
end
|
12
|
+
|
13
|
+
CONF = config_element("ROOT", "", {
|
14
|
+
"api_endpoint" => "https://zulip.example.com/api/v1/messages",
|
15
|
+
"bot_email_address" => "example-bot@example.com",
|
16
|
+
"bot_api_key" => "very-secret-value",
|
17
|
+
})
|
18
|
+
|
19
|
+
sub_test_case "configure" do
|
20
|
+
test "empty" do
|
21
|
+
assert_raise(Fluent::ConfigError) do
|
22
|
+
create_driver(config_element("", {}))
|
23
|
+
end
|
24
|
+
end
|
25
|
+
|
26
|
+
test "minimal" do
|
27
|
+
d = create_driver(CONF)
|
28
|
+
actual = {
|
29
|
+
api_endpoint: d.instance.api_endpoint,
|
30
|
+
bot_email_address: d.instance.bot_email_address,
|
31
|
+
bot_api_key: d.instance.bot_api_key
|
32
|
+
}
|
33
|
+
expected = {
|
34
|
+
api_endpoint: "https://zulip.example.com/api/v1/messages",
|
35
|
+
bot_email_address: "example-bot@example.com",
|
36
|
+
bot_api_key: "very-secret-value",
|
37
|
+
}
|
38
|
+
assert_equal(expected, actual)
|
39
|
+
end
|
40
|
+
|
41
|
+
test "no recipients when message_type is private" do
|
42
|
+
conf = CONF + config_element("", "", { "message_type" => :private })
|
43
|
+
assert_raise(Fluent::ConfigError.new("recipients are required when private message")) do
|
44
|
+
create_driver(conf)
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
test "specify both subject and subject_key" do
|
49
|
+
conf = CONF + config_element("", "", { "subject" => "test", "subject_key" => "subject" })
|
50
|
+
assert_raise(Fluent::ConfigError.new("subject and subject_key are exclusive with each other")) do
|
51
|
+
create_driver(conf)
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
55
|
+
test "subject is too long" do
|
56
|
+
conf = CONF + config_element("", "", { "subject" => "x" * 61 })
|
57
|
+
assert_raise(Fluent::ConfigError.new("subject max length is 60")) do
|
58
|
+
create_driver(conf)
|
59
|
+
end
|
60
|
+
end
|
61
|
+
end
|
62
|
+
|
63
|
+
sub_test_case "process" do
|
64
|
+
test "simple" do
|
65
|
+
d = create_driver(CONF)
|
66
|
+
record = { message: "This is test message" }
|
67
|
+
headers = {
|
68
|
+
"Connection" => "Keep-Alive",
|
69
|
+
"Accept" => "*/*",
|
70
|
+
"Accept-Encoding" => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
|
71
|
+
"Content-Type" => "application/x-www-form-urlencoded",
|
72
|
+
"User-Agent" => "Ruby"
|
73
|
+
}
|
74
|
+
stub_request(:post, "https://zulip.example.com/api/v1/messages")
|
75
|
+
.with(basic_auth: ["example-bot@example.com", "very-secret-value"],
|
76
|
+
headers: headers,
|
77
|
+
body: "type=stream;content;to=social;subject")
|
78
|
+
.to_return(headers: {},
|
79
|
+
body: { message: "", result: "success", id: 1234 }.to_json)
|
80
|
+
d.run(default_tag: "test") do
|
81
|
+
d.feed(event_time, record)
|
82
|
+
end
|
83
|
+
line = d.logs.first
|
84
|
+
message = line[/(\[info\]: \{.+\})/, 1]
|
85
|
+
assert_equal(%q([info]: {"message":"","result":"success","id":1234}), message)
|
86
|
+
end
|
87
|
+
|
88
|
+
test "http error" do
|
89
|
+
d = create_driver(CONF)
|
90
|
+
record = { message: "This is test message" }
|
91
|
+
headers = {
|
92
|
+
"Connection" => "Keep-Alive",
|
93
|
+
"Accept" => "*/*",
|
94
|
+
"Accept-Encoding" => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
|
95
|
+
"Content-Type" => "application/x-www-form-urlencoded",
|
96
|
+
"User-Agent" => "Ruby"
|
97
|
+
}
|
98
|
+
stub_request(:post, "https://zulip.example.com/api/v1/messages")
|
99
|
+
.with(basic_auth: ["example-bot@example.com", "very-secret-value"],
|
100
|
+
headers: headers,
|
101
|
+
body: "type=stream;content;to=social;subject")
|
102
|
+
.to_return(status: 500,
|
103
|
+
headers: {},
|
104
|
+
body: { message: "", result: "failure" }.to_json)
|
105
|
+
d.run(default_tag: "test") do
|
106
|
+
d.feed(event_time, record)
|
107
|
+
end
|
108
|
+
line = d.logs.first
|
109
|
+
message = line[/(\[error\]: status=.+ body=.+)/, 1]
|
110
|
+
assert_equal(%q([error]: status="500" body="{\\"message\\":\\"\\",\\"result\\":\\"failure\\"}"), message)
|
111
|
+
end
|
112
|
+
end
|
113
|
+
end
|
metadata
ADDED
@@ -0,0 +1,131 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: fluent-plugin-zulip
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Kenji Okimoto
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2017-01-30 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: test-unit
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: webmock
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: fluentd
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: 0.14.10
|
76
|
+
- - "<"
|
77
|
+
- !ruby/object:Gem::Version
|
78
|
+
version: '2'
|
79
|
+
type: :runtime
|
80
|
+
prerelease: false
|
81
|
+
version_requirements: !ruby/object:Gem::Requirement
|
82
|
+
requirements:
|
83
|
+
- - ">="
|
84
|
+
- !ruby/object:Gem::Version
|
85
|
+
version: 0.14.10
|
86
|
+
- - "<"
|
87
|
+
- !ruby/object:Gem::Version
|
88
|
+
version: '2'
|
89
|
+
description: Fluentd output plugin for Zulip powerful open source group chat.
|
90
|
+
email:
|
91
|
+
- okimoto@clear-code.com
|
92
|
+
executables: []
|
93
|
+
extensions: []
|
94
|
+
extra_rdoc_files: []
|
95
|
+
files:
|
96
|
+
- ".gitignore"
|
97
|
+
- Gemfile
|
98
|
+
- LICENSE
|
99
|
+
- README.md
|
100
|
+
- Rakefile
|
101
|
+
- fluent-plugin-zulip.gemspec
|
102
|
+
- lib/fluent/plugin/out_zulip.rb
|
103
|
+
- test/helper.rb
|
104
|
+
- test/plugin/test_out_zulip.rb
|
105
|
+
homepage: https://github.com/fluent-plugins-nursery/fluent-plugin-zulip
|
106
|
+
licenses:
|
107
|
+
- Apache-2.0
|
108
|
+
metadata: {}
|
109
|
+
post_install_message:
|
110
|
+
rdoc_options: []
|
111
|
+
require_paths:
|
112
|
+
- lib
|
113
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - ">="
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0'
|
118
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
119
|
+
requirements:
|
120
|
+
- - ">="
|
121
|
+
- !ruby/object:Gem::Version
|
122
|
+
version: '0'
|
123
|
+
requirements: []
|
124
|
+
rubyforge_project:
|
125
|
+
rubygems_version: 2.6.8
|
126
|
+
signing_key:
|
127
|
+
specification_version: 4
|
128
|
+
summary: Fluentd output plugin for Zulip powerful open source group chat.
|
129
|
+
test_files:
|
130
|
+
- test/helper.rb
|
131
|
+
- test/plugin/test_out_zulip.rb
|