logstash-output-rocketchat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d20c7f02c37817fc79c56c94a9b750c9489abd72d9569326aa1926d9388a555b
+  data.tar.gz: c0170d3f9dcf144ef35989fbff8cac04f6532d13b0ad8c365572b7c3a88c738e
+SHA512:
+  metadata.gz: cd8c6f5c3be0f9809a29da1852440d964f1f017385e462a446402cce7bcc21c9cc7c3b07ac286a8e71a9a45e4a1a5755a3f060623afa24e9244b5a63b02acbb8
+  data.tar.gz: a3609cc25ba4c45a91c374bdd8da018aed39d2064ab1dad3d3daf2b3f69d1a5e034c7e720ed60f5ba450760210ce8158eebdb4d7a378647ae4c67de2c89c1051

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  - Plugin created with the logstash plugin generator

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* ffknob - ffknob@tce.rs.gov.br
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-output-rocketchat
+Example output plugin. This should help bootstrap your effort to write your own output plugin!

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/LICENSE

@@ -0,0 +1,11 @@
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,86 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/logstash-plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/outputs/rocketchat.rb

@@ -0,0 +1,233 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+
+# Rocket.Chat is free, unlimited and open source. Replace email, HipChat & Slack with the ultimate team chat software solution.
+#
+# This Logstash output plugin allows to send events as messages to channels and groups of a Rocketchat server.
+
+# An rocketchat output that does nothing.
+class LogStash::Outputs::Rocketchat < LogStash::Outputs::Base
+  config_name "rocketchat"
+
+  # Host address of the Rocketchat server
+  config :host, :validate => :string, :required => true
+
+  # Port in which the Rocketchat server is listening
+  config :port, :validate => :string,:default => 3000
+
+  # Http or https
+  config :scheme, :validate => :string, :default => "http"
+
+  # API route
+  config :api, :validate => :string, :default => "/api/v1"
+
+  # Username to use for the integration
+  config :username, :validate => :string, :required => true
+
+  # Password of the user
+  config :password, :validate => :string, :required => true
+
+  # A list of channels/groups to which the messages will be posted 
+  config :channels, :validate => :string, :required => true, :list => true
+
+  # Format of the message (content)
+  config :format, :validate => :string, :default => "%{message}"
+
+  concurrency :single
+
+  public
+  def register
+	  m = __method__.to_s
+
+    require 'rest-client'
+    require 'cgi'
+    require 'json'
+	
+	  raw_url = "#{@scheme}://#{@host}:#{@port}#{@api}"
+	  @url = ::LogStash::Util::SafeURI.new(raw_url)
+
+	  @logger.info("[#{m}] URL #{@url}, Username: #{@username}, Channel: #{@channels}")
+
+    auth()
+  end # def register
+
+  public
+  def receive(event)
+	  return unless output?(event)
+
+    m = __method__.to_s
+
+    message = event.sprintf(@format)
+
+    @channels.map {|channel|
+      if send_message(channel, message)
+        @logger.debug("[#{m}] Message sent to room #{channel}")
+      else
+        @logger.error("[#{m}] An error occurred trying to send a message to room #{channel}.")
+      end
+    }
+
+  end # def event
+
+  public
+  def auth()
+	  m = __method__.to_s
+
+	  @logger.debug("[i#{m}] Trying to authenticate")
+
+    endpoint = "#{@url}/login"
+
+    payload = Hash.new
+    payload['username'] = @username 
+    payload['password'] = @password 
+
+	  @logger.debug("[#{m}] Endpoint: #{endpoint}, payload: #{payload}")
+
+    body = make_request('POST', endpoint, nil, payload)
+
+	  if body.nil?
+      @logger.error("[#{m}] An error occurred trying to authenticate to the Rocketchat server")
+	    return false
+	  else
+      status = body['status']
+	    if status == 'success'
+        @userId = body['data']['userId']
+        @authToken = body['data']['authToken']
+	      return true
+	    end
+    end
+  end # def auth
+
+  public
+  def get_room_id(room_name)
+	  m = __method__.to_s
+
+	  @logger.debug("[#{m}] Trying to get the room id for room #{room_name}")
+  
+    endpoint = "#{@url}/channels.info"
+	  body = make_request('GET', endpoint, {:roomName => room_name}, nil)
+
+	  if body.nil?
+      @logger.error("[#{m}] An error occurred trying to get the room id (channels endpoint) for room #{room_name}")
+	  else
+	    success = body['success']
+      if success
+	      return body['channel']['_id']
+		  else
+        @logger.info("[#{m}] Couldn't get the room id for room #{room_name} through the channels endpoint, trying with the groups endpoint")
+
+        endpoint = "#{@url}/groups.info"
+	      body = make_request('GET', endpoint, {:roomName => room_name}, nil)
+
+		    if body.nil?
+        	@logger.error("[#{m}] An error occurred trying to get the room id (groups endpoint) for room #{room_name}")
+		    else
+		      success = body['success']
+			    if success
+		  	    return body['group']['_id']
+			    else
+			      return nil
+			    end
+		    end	  
+		  end
+    end
+
+    return nil
+  end # def get_room_id
+
+  public
+  def send_message(room_name, message)
+	  m = __method__.to_s
+
+	  @logger.debug("[#{m}] Trying to send message to room #{room_name}")
+  
+    endpoint = "#{@url}/chat.sendMessage"
+
+    room_id = get_room_id(room_name)
+
+    if room_id
+      payload = Hash.new
+      payload['message'] = Hash.new
+      payload['message']['rid'] = room_id 
+      payload['message']['msg'] = message
+  
+      body = make_request('POST', endpoint, nil, payload)
+  
+      if body.nil?
+        @logger.error("[#{m}] An error occurred trying to send message to the Rocketchat server, room #{room_name}")
+        return false
+      else
+        status = body['status']
+        if status == 'success'
+          return true
+        end
+      end      
+    else
+      @logger.warn("[#{m}] An error occurred trying to get the room id for room #{room_name}. Are you sure the user #{@user} is sunscripted to this room?")
+    end
+    
+    return nil
+  end # def send_message
+
+  public
+  def make_request(method, endpoint, params = nil, payload = nil)
+	  m = __method__.to_s
+
+	  @logger.debug("[#{m}] Making a #{method} request to #{endpoint}")
+	  @logger.debug("[#{m}] Auth token: #{@authToken}")
+    @logger.debug("[#{m}] User id: #{@userId}")
+    @logger.debug("[#{m}] Params: #{params}")
+    @logger.debug("[#{m}] Payload: #{payload}")
+
+    begin
+      if method == 'POST'
+        RestClient.post(
+          endpoint,
+          JSON.dump(payload),
+          {
+            :'X-Auth-Token' => @authToken || '',
+            :'X-User-Id' => @userId || '' ,
+            :accept => "application/json",
+            :'User-Agent' => "logstash-output-rocketchat",
+            :content_type => @content_type
+          }) { |response, request, result, &block|
+            if response.code != 200
+              @logger.error("[#{m}] An error occurred trying to request from the Rocketchat's server API: #{response.code}")
+              @logger.debug("[#{m}] Got a #{response.code} response: #{response}")
+
+              return response.body ? JSON.parse(response.body) : nil
+		        else
+              @logger.debug("[#{m}] Got a #{response.code} response: #{response}")
+
+              return response.body ? JSON.parse(response.body) : nil
+            end
+          }
+      elsif method == 'GET'
+        RestClient.get(
+          endpoint,
+		      {
+          	:params => params,
+			      :'X-Auth-Token' => @authToken || '',
+		  	    :'X-User-Id' => @userId || '' ,
+          	:accept => "application/json",
+          	:'User-Agent' => "logstash-output-rocketchat",
+          	:content_type => @content_type
+		      }) { |response, request, result, &block|
+            if response.code != 200
+              @logger.error("[#{m}] An error occurred trying to request from the Rocketchat's server API: #{response.code}")
+              @logger.debug("[#{m}] Got a #{response.code} response: #{response}")
+
+              return response.body ? JSON.parse(response.body) : nil
+		        else
+              @logger.debug("[#{m}] Got a #{response.code} response: #{response}")
+
+              return response.body ? JSON.parse(response.body) : nil
+            end
+	      }
+      end
+    rescue Exception => e
+      @logger.error("[#{m}] Unhandled exception", :exception => e, :stacktrace => e.backtrace)
+    end
+  end # def make_request
+end # class LogStash::Outputs::Rocketchat

data/logstash-output-rocketchat.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-output-rocketchat'
+  s.version       = '0.1.0'
+  s.licenses      = ['Apache-2.0']
+  s.summary       = 'Writes events to Rocketchat.'
+  s.description   = 'Rocket.Chat is the leading open source team chat software solution. Free, unlimited and completely customizable with on-premises and SaaS cloud hosting. This Logstash plugin allows to send events to Rocketchat''s channels.'
+  s.homepage      = 'https://github.com/ffknob/logstash-output-rocketchat'
+  s.authors       = ['ffknob']
+  s.email         = 'ffknob@tce.rs.gov.br'
+  s.require_paths = ['lib']
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
+  s.add_runtime_dependency "logstash-codec-plain"
+  s.add_runtime_dependency "rest-client", '~> 1.8', ">= 1.8.0"
+  s.add_development_dependency "logstash-devutils"
+  s.add_development_dependency "logstash-filter-json"
+end

data/spec/outputs/rocketchat_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/outputs/rocketchat"
+require "logstash/codecs/plain"
+require "logstash/event"
+
+describe LogStash::Outputs::Rocketchat do
+  let(:sample_event) { LogStash::Event.new }
+  let(:output) { LogStash::Outputs::Rocketchat.new }
+
+  before do
+    output.register
+  end
+
+  describe "receive message" do
+    subject { output.receive(sample_event) }
+
+    it "returns a string" do
+      expect(subject).to eq("Event received")
+    end
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-rocketchat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ffknob
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2019-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-codec-plain
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  name: rest-client
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-filter-json
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rocket.Chat is the leading open source team chat software solution. Free,
+  unlimited and completely customizable with on-premises and SaaS cloud hosting. This
+  Logstash plugin allows to send events to Rocketchats channels.
+email: ffknob@tce.rs.gov.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/outputs/rocketchat.rb
+- logstash-output-rocketchat.gemspec
+- spec/outputs/rocketchat_spec.rb
+homepage: https://github.com/ffknob/logstash-output-rocketchat
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: output
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
+specification_version: 4
+summary: Writes events to Rocketchat.
+test_files:
+- spec/outputs/rocketchat_spec.rb