rodbot 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bf9f1ee8fd09d93797a5ba276aa6fec09be9620e540f118240525c73a6fda6b
-  data.tar.gz: b36fdd850e38596aaf7da805107d0cbbbcb46de823e76cad151676fbcc14dd9c
+  metadata.gz: eac36ded2dc61a62f3a5e9c236987ff66f0aadf65f216b96932375af2cec3241
+  data.tar.gz: '099b12406aa01b8ec165efb25a3faef9fd1efeed3a8c9a7c0c0bb05febadf2e8'
 SHA512:
-  metadata.gz: 37a9346640167dc0543d9361b1d53789e363d27e6c57129fde777897f7e8ec3fff51e735129accdfaf8caee943a29fa19daae2ea5acdab6023d11d7dbf4ebaaa
-  data.tar.gz: 6fec833877807a7b6dc85e19682c5bf88172ad2ff32ce0d0c5e83565cecbf60e54517f1aaeda451e17ee610f5338969bd05ffe5a8c002b649c28c3e35f25949b
+  metadata.gz: 06d6953cd85005effd3a54da59564e52a27d27cb42f61ccc2aeb0dfa32627a38d96f9e07fd9ba7d533fdf4210180d228582e5b39672a4124eba9831abb443016
+  data.tar.gz: cec0a4d433b447c34fa91ff7a7fd9df416648851ef5b8156fb3d01579ac2d1abb26e7738ee000b1bdb322575dc99c5f8ac635843e1ecfc07d439b3b3403fddb9

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 Nothing so far
 
+## 0.3.4
+
+#### Additions
+* Support to post to secondary rooms with `Rodbot.say`
+* `Rodbot::Message` container class for messages with meta data
+
+## 0.3.3
+
+#### Additions
+* Support placeholders when using `Rodbot.say` and add `[[EVERYBODY]]`
+  placeholder to mention all hands in a room or channel
+
 ## 0.3.2
 
 #### Additions

data/README.md

@@ -166,6 +166,7 @@ The response may contain special tags which have to be replace appropriately by
 Tag | Replaced with
 ----|--------------
 `[[SENDER]]` | Mention the sender of the command.
+`[[EVERYBODY]]` | Mention everybody.
 
 #### Other Routes
 
@@ -177,7 +178,7 @@ The **relay service** act as glue between the **app service** and external commu
 
 Each relay service does three things:
 
-* **Proactive:** It creates and listens to a local TCP socket. Plain text or Markdown sent to this socket is forwarded as a message to the corresponding communication network. This text may have multiple lines, use the EOT character (`\x04` alias Ctrl-D) to mark the end.
+* **Proactive:** It creates and listens to a local TCP socket which accepts and forwards messages. See below for more on this.
 * **Reactive:** It reads messages, detects commands usually beginning with a `!`, forwards them to the **app service** and writes the HTTP response back as a message to the communication network.
 * **Test:** It detects the `!ping` command and replies with "pong" *without* hitting the **app service**.
 
@@ -189,6 +190,14 @@ rodbot simulator
 
 Enter the command `!pay EUR 123` and you see the request `GET /pay?argument=EUR+123` hitting the **app service**.
 
+#### TCP Socket
+
+The TCP socket is primarily used by other Rodbot services to forward messages to the corresponding external communication network. However, you can use these sockets for non-Rodbot processes as well e.g. to issue notifications when events happen on the host running Rodbot.
+
+Simply connect to a socket and submit the message as plain text or Markdown in UTF-8. Multiple lines are allowed, to finish and post the message, append the EOT character (`\x04` alias Ctrl-D).
+
+Such simple messages are always posted to the primary room (aka: channel, group etc) of the communication network. For more complex scenarios, please take a look at [message objects](https://www.rubydoc.info/gems/rodbot/Rodbot/Message) which may contain meta information as well.
+
 ### Schedule Service
 
 The **schedule service** is a [Clockwork process](https://github.com/Rykian/clockwork) which triggers Ruby code asynchronously as configured in `config/schedule.rb`.

data/checksums/rodbot-0.3.3.gem.sha512

@@ -0,0 +1 @@
+de9183abfb13dd5098ca5e8e2cba6b0e27f349c2e90b85ef387e5b81730ff7d911f29b47b7e4900719e198514d097513f109916c6e64f2b9361237b35b5b0a70

data/checksums/rodbot-0.3.4.gem.sha512

@@ -0,0 +1 @@
+ab32834eec05a817fafa249e06330e30cb39e08b7234b46b9ae9787c03f6900ab7e6202a7c364f9ae93d5028669561ef31bcc1445f9e8990d6f2f992e60f4032

data/lib/rodbot/message.rb

@@ -0,0 +1,89 @@
+# frozen-string-literal: true
+
+module Rodbot
+
+  # Generic serializable chat message container
+  #
+  # The primary purpose of message objects is their ability to contain both
+  # the actual message text as well as meta data such as the room in which the
+  # message was or will be posted.
+  #
+  # Furthermore, they can be serialized (+dump+) and then recreated (+new+)
+  # from that. You can also create a serialized message string outside of RodBot
+  # performing the following steps:
+  #
+  # 1. Create a JSON hash which contains the keys +class+ (with static value
+  #    +Rodbot::Message+), +text+ and optionally +room+.
+  # 2. Encode it as Base64 without newlines.
+  # 3. Prefix the result with {Rodbot::Serializer::PRELUDE}.
+  #
+  # Example for Shell:
+  #   string='{"class":"Rodbot::Message",text":"hello, world","room":"general"}'
+  #   string=$(echo $string | base64)
+  #   string="data:application/json;base64,$string"
+  #   echo $string
+  class Message
+
+    # Raw message text
+    #
+    # @return [String, nil]
+    attr_reader :text
+
+    # Room (aka: channel, group etc depending on the chat service) in which
+    # the message was or will be posted
+    #
+    # @return [String, nil]
+    attr_accessor :room
+
+    # Initialize message from raw message text
+    #
+    # @param text [String] raw message text
+    # @param room [String, nil] room in which the message was or will be posted
+    def initialize(text, room: nil)
+      @text, @room = text, room
+    end
+
+    # Initialize message from either message object previously serialized with
+    # +dump+ or from raw message text
+    #
+    # @param string [String] string returned by +dump+ or raw message text
+    # @param room [String, nil] room in which the message was or will be posted
+    # @raise [ArgumentError] if the string is not valid Base64, JSON or does not
+    #   contain the key +"class":"Rodbot::Message"+
+    def self.new(string, room: nil)
+      allocate.instance_eval do
+        serializer = Rodbot::Serializer.new(string)
+        if serializer.deserializable?
+          hash = serializer.hash
+          fail(ArgumentError, "not a dumped message") unless hash['class'] == self.class.to_s
+          initialize(hash['text'], room: room || hash['room'])
+        else
+          initialize(string.force_encoding('UTF-8'), room: room)
+        end
+        self
+      end
+    end
+
+    # Serialize the message
+    #
+    # @return [String] serialized and encoded +self+
+    def dump
+      Rodbot::Serializer.new(to_h).string
+    end
+
+    # Convert message to Hash
+    #
+    # @return [Hash]
+    def to_h
+      { class: self.class.to_s, text: text, room: room }
+    end
+
+    # Whether two messages are equal
+    #
+    # @return [Boolean]
+    def ==(other)
+      to_h == other.to_h
+    end
+
+  end
+end

data/lib/rodbot/plugins/github_webhook/app.rb

@@ -10,7 +10,7 @@ module Rodbot
             r.post '' do
               r.halt 200 if request.env['HTTP_X_GITHUB_EVENT'] == 'ping'
               r.halt 400 unless request.env['HTTP_X_GITHUB_EVENT'] == 'workflow_run'
-              r.halt 401 unless authorized? request
+              r.halt 401 unless authorized?
               json = JSON.parse(request.body.read)
               project = json.dig('repository', 'full_name')
               status = json.dig('workflow_run', 'status')
@@ -22,7 +22,7 @@ module Rodbot
 
           private
 
-          def authorized?(request)
+          def authorized?
             Rodbot.config(:plugin, :github_webhook, :secret_tokens).to_s.split(':').any? do |secret|
               signature = 'sha256=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), secret, request.body.read)
               request.body.rewind

data/lib/rodbot/plugins/gitlab_webhook/app.rb

@@ -8,7 +8,7 @@ module Rodbot
         class Routes < ::App
           route do |r|
             r.post '' do
-              r.halt 401 unless authorized? request
+              r.halt 401 unless authorized?
               json = JSON.parse(request.body.read)
               r.halt 400 unless json['object_kind'] == 'pipeline'
               project = json.dig('project', 'path_with_namespace')
@@ -20,7 +20,7 @@ module Rodbot
 
           private
 
-          def authorized?(request)
+          def authorized?
             Rodbot.config(:plugin, :gitlab_webhook, :secret_tokens).to_s.split(':').include?(request.env['HTTP_X_GITLAB_TOKEN'])
           end
 

data/lib/rodbot/plugins/matrix/README.matrix.md

@@ -40,3 +40,15 @@ You might want to use the credentials facilities of Rodbot to encrypt the token.
 Once Rodbot is restarted, the Matrix relay will automatically accept the invitation and start listening. To check whether the relay works fine, just say +!ping+ in the room, you should receive a "pong" in reply.
 
 Any room message beginning with "!" is considered a bot command.
+
+To post messages to the primary channel configured with the plugin:
+
+```
+Rodbot.say('Hello, world!')
+```
+
+It's possible to post to other, secondary channels, provided you have previously added the bot app to those secondary channels as [described above](#preparation):
+
+```
+Rodbot.say('Hello, world!', room: '#general:matrix.org')
+```

data/lib/rodbot/plugins/matrix/relay.rb

@@ -38,7 +38,7 @@ module Rodbot
         end
 
         memoize def client
-          MatrixSdk::Client.new(homeserver, access_token: access_token, client_cache: :some)
+          MatrixSdk::Client.new(homeserver, access_token: access_token, client_cache: :some).tap(&:reload_rooms!)
         end
 
         memoize def room
@@ -57,10 +57,10 @@ module Rodbot
           server = TCPServer.new(*bind)
           loop do
             Thread.start(server.accept) do |remote|
-              body = remote.gets("\x04")
+              message = Rodbot::Message.new(remote.gets("\x04").chop)
               remote.close
-              body.force_encoding('UTF-8')
-              room.send_html body.md_to_html
+              target_room = message.room ? client.find_room(message.room) : room
+              target_room.send_html message.text.psub(placeholders).md_to_html
             end
           end
         end
@@ -78,12 +78,13 @@ module Rodbot
         def reply_to(message)
           command(*message.content[:body][1..].split(/\s+/, 2)).
             md_to_html.
-            psub(placeholders(client.get_user(message.sender)))
+            psub(placeholders(sender: client.get_user(message.sender)))
         end
 
-        def placeholders(sender)
+        def placeholders(locals={})
           {
-            sender: "https://matrix.to/#/#{sender.id}"
+            sender: ("https://matrix.to/#/#{locals[:sender].id}" if locals[:sender]),
+            everybody: "https://matrix.to/#room"
           }
         end
 

data/lib/rodbot/plugins/slack/README.slack.md

@@ -46,3 +46,17 @@ You might want to use the credentials facilities of Rodbot to encrypt the token.
 Once Rodbot is restarted, the Slack relay starts listening. To check whether the relay works fine, just say +!ping+ in the channel, you should receive a "pong" in reply.
 
 Any room message beginning with "!" is considered a bot command.
+
+To post messages to the primary channel configured with the plugin:
+
+```
+Rodbot.say('Hello, world!')
+```
+
+It's possible to post to other, secondary channels, provided you have previously added the bot app to those secondary channels as [described above](#preparation):
+
+```
+Rodbot.say('Hello, world!', room: '#general')
+```
+
+Please note that Rodbot uses the term "room" for what is called a channel on Slack.

data/lib/rodbot/plugins/slack/relay.rb

@@ -39,12 +39,11 @@ module Rodbot
           server = TCPServer.new(*bind)
           loop do
             Thread.start(server.accept) do |remote|
-              body = remote.gets("\x04")
+              message = Rodbot::Message.new(remote.gets("\x04").chop)
               remote.close
-              body.force_encoding('UTF-8')
               client.web_client.chat_postMessage(
-                channel: channel_id,
-                text: md_to_slack_text(body),
+                channel: message.room || channel_id,
+                text: md_to_slack_text(message.text.psub(placeholders)),
                 as_user: true
               )
             end
@@ -70,14 +69,15 @@ module Rodbot
 
         def reply_to(message)
           command(*message.text[1..].split(/\s+/, 2)).
-            psub(placeholders(message.user)).
+            psub(placeholders(sender: message.user)).
             then { md_to_slack_text(_1) }
         end
 
         # @see https://api.slack.com/reference/surfaces/formatting
-        def placeholders(sender)
+        def placeholders(locals={})
           {
-            sender: "<@#{sender}>"
+            sender: ("<@#{locals[:sender]}>" if locals[:sender]),
+            everybody: "<!channel>"
           }
         end
 

data/lib/rodbot/relay.rb

@@ -18,15 +18,16 @@ module Rodbot
       # "say true" configured in their corresponding config blocks. To further
       # narrow it to exactly one relay service, use the +on+ argument.
       #
-      # @param message [String] message to post
+      # @param text [String] message to post
       # @param on [Symbol, nil] post via this relay service only
+      # @param room [String, nil] post to this room (aka: channel, group etc)
       # @return [Boolean] +false+ if at least one relay refused the connection or
       #   +true+ otherwise
-      def say(message, on: nil)
+      def say(text, on: nil, room: nil)
         Rodbot.config(:plugin).select do |extension, config|
           config[:say] == true && (!on || extension == on)
         end.keys.inject(true) do |success, extension|
-          write(message, extension) && success
+          write(Rodbot::Message.new(text, room: room).dump, extension) && success
         end
       end
 

data/lib/rodbot/serializer.rb

@@ -0,0 +1,65 @@
+# frozen-string-literal: true
+
+require 'json'
+require 'base64'
+
+module Rodbot
+
+  # Simple yet safe Hash to String serializer
+  #
+  # Keep in mind that hash keys will always be deserialized as strings!
+  #
+  # Example:
+  #   hash = { 'foo' => 'bar' }
+  #   string = Serializer.new(hash).string
+  #   # => "data:application/json;base64,eyJmb28iOiJiYXIifQ=="
+  #   hash = Serializer.new(string).hash
+  #   # => { 'foo' => 'bar' }
+  class Serializer
+
+    # Prelude string for serialized hash
+    PRELUDE = 'data:application/json;base64,'
+
+    # @params object [Hash, String] either a Hash (to serialize) or a String
+    #   (to deserialize)
+    def initialize(object)
+      case object
+        when Hash then @hash = object
+        when String then @string = object
+        else fail ArgumentError, "must be either Hash or String"
+      end
+    end
+
+    # @return [String] Hash serialized to String
+    def string
+      @string ||= begin
+        fail "object is not serializable" unless serializable?
+        @hash.to_json.then { PRELUDE + Base64.strict_encode64(_1) }
+      end
+    end
+
+    # @return [Hash] String deserialized to Hash
+    # @raise [RuntimeError] when deserialization fails
+    def hash
+      @hash ||= begin
+        fail "object is not deserializable" unless deserializable?
+        JSON.load(Base64.strict_decode64(@string.delete_prefix(PRELUDE)))
+      end
+    rescue ArgumentError
+      raise "invalid Base64"
+    rescue JSON::ParserError
+      raise "invalid JSON"
+    end
+
+    # @return [Boolean] whether the object passed with +new+ is serializable
+    def serializable?
+      !!@hash
+    end
+
+    # @return [Boolean] whether the object passed with +new+ is deserializable
+    def deserializable?
+      @string && @string.match?(/\A#{PRELUDE}/)
+    end
+
+  end
+end

data/lib/rodbot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rodbot
-  VERSION = "0.3.2"
+  VERSION = "0.3.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rodbot
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.4
 platform: ruby
 authors:
 - Sven Schwyn
@@ -29,7 +29,7 @@ cert_chain:
   kAyiRqgxF4dJviwtqI7mZIomWL63+kXLgjOjMe1SHxfIPo/0ji6+r1p4KYa7o41v
   fwIwU1MKlFBdsjkd
   -----END CERTIFICATE-----
-date: 2023-10-18 00:00:00.000000000 Z
+date: 2023-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -452,6 +452,8 @@ files:
 - checksums/rodbot-0.3.0.gem.sha512
 - checksums/rodbot-0.3.1.gem.sha512
 - checksums/rodbot-0.3.2.gem.sha512
+- checksums/rodbot-0.3.3.gem.sha512
+- checksums/rodbot-0.3.4.gem.sha512
 - doc/rodbot.afphoto
 - doc/rodbot.avif
 - exe/rodbot
@@ -482,6 +484,7 @@ files:
 - lib/rodbot/generator.rb
 - lib/rodbot/log.rb
 - lib/rodbot/memoize.rb
+- lib/rodbot/message.rb
 - lib/rodbot/plugins.rb
 - lib/rodbot/plugins/github_webhook/README.github_webhook.md
 - lib/rodbot/plugins/github_webhook/app.rb
@@ -500,6 +503,7 @@ files:
 - lib/rodbot/rack.rb
 - lib/rodbot/refinements.rb
 - lib/rodbot/relay.rb
+- lib/rodbot/serializer.rb
 - lib/rodbot/services.rb
 - lib/rodbot/services/app.rb
 - lib/rodbot/services/relay.rb