logstash-output-rocketchat 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9983abca8265a54f9432a67c2d18ebf751b7c1e065d1b8718562a0cd736a400
-  data.tar.gz: 51901b0d9fd53bcdd754b2bd916541e1c514283856e9184fa4d6835aac9177e7
+  metadata.gz: 44b757b06ab254981ccc585669f4076333cfa2fc9dc1cd0a9b424d4e39f52636
+  data.tar.gz: 45a307633b6816f649af2f1421606b2828be2debc33e90235ca525c6fa6343f4
 SHA512:
-  metadata.gz: 47f7cd04aede88bd16e42fd927bc6a0505213d4ba5e87fe333abe2e9f86ef3c07ab76d928204f18e04d4ed47ff2c94b4f63a5ed75a195ef0c42e5cef594bebf8
-  data.tar.gz: 7e1cbcf0f0d01c24a8994251b19f23e2ba760468d4a14357ba1366524c42e74a7c6874a3b9fa3b5038c0a711ad9c30bbdab91fbc13091cdc58987d7f70010fc5
+  metadata.gz: a353fe8fe553f1650b71553d91b7e87cd5946e0af7909413694ca7a9bfa7b71f6905541945b02183710e8eb62a2fbc8256ce765c809ad9744dce4a9ef14792b2
+  data.tar.gz: ab1a982a25ed8ba58e04ac7555255c442167ffa64fe9ad168ab62ecad2c34a146e8a2e90b2db495ee1db20be3a2991829ced1d949d98a3d0a498bbd01d202b9e

data/lib/logstash/outputs/rocketchat.rb

@@ -20,6 +20,7 @@ require "logstash/namespace"
 #     username => "rc_integrations"
 #     password => "p@$$w0rd"
 #     channels => ["management", "operations", "rh"]
+#     content => "My message: %{message}"
 #   }
 # }
 # ----------------------------------
@@ -51,8 +52,8 @@ class LogStash::Outputs::Rocketchat < LogStash::Outputs::Base
   # 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}"
+  # Message's content to be sent
+  config :content, :validate => :string, :default => "%{message}"
 
   concurrency :single
 
@@ -63,12 +64,18 @@ class LogStash::Outputs::Rocketchat < LogStash::Outputs::Base
     require 'rest-client'
     require 'cgi'
     require 'json'
-	
+  
+    # Rocketchat's API
+    # More information in https://rocket.chat/docs/developer-guides/rest-api/
 	  raw_url = "#{@scheme}://#{@host}:#{@port}#{@api}"
-	  @url = ::LogStash::Util::SafeURI.new(raw_url)
+    @url = ::LogStash::Util::SafeURI.new(raw_url)
+    
+    # We'll keep the rooms' ids so we don't need to ask again for each event
+    @room_ids = Hash.new
 
 	  @logger.info("[#{m}] URL #{@url}, Username: #{@username}, Channel: #{@channels}")
 
+    # We need to grab a token from Rocketchat  
     auth()
   end # def register
 
@@ -78,8 +85,10 @@ class LogStash::Outputs::Rocketchat < LogStash::Outputs::Base
 
     m = __method__.to_s
 
-    message = event.sprintf(@format)
+    # The message itself
+    message = event.sprintf(@content)
 
+    # To which channels/groups should the message be sent
     @channels.map {|channel|
       if send_message(channel, message)
         @logger.debug("[#{m}] Message sent to room #{channel}")
@@ -94,16 +103,19 @@ class LogStash::Outputs::Rocketchat < LogStash::Outputs::Base
   def auth()
 	  m = __method__.to_s
 
-	  @logger.debug("[i#{m}] Trying to authenticate")
+	  @logger.debug("[#{m}] Trying to authenticate")
 
+    # https://rocket.chat/docs/developer-guides/rest-api/authentication/login/
     endpoint = "#{@url}/login"
 
+    # We have to send a valid username/password in order to get a token
     payload = Hash.new
     payload['username'] = @username 
     payload['password'] = @password 
 
 	  @logger.debug("[#{m}] Endpoint: #{endpoint}, payload: #{payload}")
 
+    # Go get this token...
     body = make_request('POST', endpoint, nil, payload)
 
 	  if body.nil?
@@ -111,7 +123,8 @@ class LogStash::Outputs::Rocketchat < LogStash::Outputs::Base
 	    return false
 	  else
       status = body['status']
-	    if status == 'success'
+      if status == 'success'
+        # If it succeds, then we'll have an user id. and an authentication token
         @userId = body['data']['userId']
         @authToken = body['data']['authToken']
 	      return true
@@ -123,20 +136,32 @@ class LogStash::Outputs::Rocketchat < LogStash::Outputs::Base
   def get_room_id(room_name)
 	  m = __method__.to_s
 
-	  @logger.debug("[#{m}] Trying to get the room id for room #{room_name}")
+	  @logger.debug("[#{m}] Trying to get the room's id for room #{room_name}")
   
+    # Have we got the room's id already?
+    if @room_ids.key?(room_name)
+      @logger.debug("[#{m}] Already got the id for room #{room_name}, no need to ask Rocketchat server")
+      return @room_ids[room_name]
+    end
+
+    # https://rocket.chat/docs/developer-guides/rest-api/channels/info/
     endpoint = "#{@url}/channels.info"
-	  body = make_request('GET', endpoint, {:roomName => room_name}, nil)
+    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']
+        # It's a channel... return the room's id
+        @logger.debug("[#{m}] Room #{room_name} is a channel, saving its id so we don't need to ask for it anymore")
+        @room_ids[:room_name] = body['channel']['_id']
+        @logger.debug("[#{m}] Rooms' ids: #{@room_ids}")
+        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")
 
+        # https://rocket.chat/docs/developer-guides/rest-api/groups/info/
         endpoint = "#{@url}/groups.info"
 	      body = make_request('GET', endpoint, {:roomName => room_name}, nil)
 
@@ -144,7 +169,11 @@ class LogStash::Outputs::Rocketchat < LogStash::Outputs::Base
         	@logger.error("[#{m}] An error occurred trying to get the room id (groups endpoint) for room #{room_name}")
 		    else
 		      success = body['success']
-			    if success
+          if success
+            # It's a group... return the room's id
+            @logger.debug("[#{m}] Room #{room_name} is a group, saving its id so we don't need to ask for it anymore")
+            @room_ids[:room_name] = body['group']['_id']
+            @logger.debug("[#{m}] Rooms' ids: #{@room_ids}")
 		  	    return body['group']['_id']
 			    else
 			      return nil
@@ -160,10 +189,12 @@ class LogStash::Outputs::Rocketchat < LogStash::Outputs::Base
   def send_message(room_name, message)
 	  m = __method__.to_s
 
-	  @logger.debug("[#{m}] Trying to send message to room #{room_name}")
+	  @logger.debug("[#{m}] Trying to a send message to room #{room_name}")
   
+    # https://rocket.chat/docs/developer-guides/rest-api/chat/sendmessage/
     endpoint = "#{@url}/chat.sendMessage"
 
+    # Go get the room's id
     room_id = get_room_id(room_name)
 
     if room_id
@@ -178,16 +209,20 @@ class LogStash::Outputs::Rocketchat < LogStash::Outputs::Base
         @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'
+        success = body['success']
+        if success
+          # Message sent
           return true
+        else
+          # Something went wrong
+          return false
         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?")
+      @logger.warn("[#{m}] An error occurred trying to get the room id for room #{room_name}. Are you sure the user #{@user} is subscribed to this room?")
     end
     
-    return nil
+    return false
   end # def send_message
 
   public

data/logstash-output-rocketchat.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-output-rocketchat'
-  s.version       = '0.1.2'
+  s.version       = '0.1.3'
   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 channelsi and groups.' 
+  s.summary       = 'Sends messages to a Rocketchat server with information from the events.'
+  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 channels and groups.' 
   s.homepage      = 'https://github.com/ffknob/logstash-output-rocketchat'
   s.authors       = ['ffknob']
   s.email         = 'ffknob@tce.rs.gov.br'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-rocketchat
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - ffknob
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-01-29 00:00:00.000000000 Z
+date: 2019-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +94,7 @@ dependencies:
         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 Rocketchat channelsi and groups.
+  Logstash plugin allows to send events to Rocketchat channels and groups.
 email: ffknob@tce.rs.gov.br
 executables: []
 extensions: []
@@ -134,6 +134,6 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key:
 specification_version: 4
-summary: Writes events to Rocketchat.
+summary: Sends messages to a Rocketchat server with information from the events.
 test_files:
 - spec/outputs/rocketchat_spec.rb