rodbot 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f32541e2113ba1425a81da6374fc3353d578ba5fd0b9b1905f5eeae95fab0180
-  data.tar.gz: ad474b634ffa0fb96fe23cb7602b9de81df2367636cb0327cce578901237615d
+  metadata.gz: 6e6caa3fc8d7a38fb433cc01dedd9e521f2a7c2cd79ebaa4f78396c39f1a5cfc
+  data.tar.gz: 8d7f438f66d0d8494c7629ea3f1f363f730ce34a0c5178aaca0ee580e6a7a512
 SHA512:
-  metadata.gz: 45fc1790e2d559610ebca8ce834bcaf245f6fb922e18edd56d55f2ee307fbf2daffe2db10b507efc1944d27e4c562577108013c48186e6a743bf2e5cd1dfe67b
-  data.tar.gz: 9787f11da1619228e571644be1643e66d3b4b65f46ed14d2782b9b20a73b35f98f33bce02bd26c5dd7677e377e09874945412155cca9e55e220363cd41776e4a
+  metadata.gz: 7ddbdf27810f750712ff0a7990ec6da94d084a289c9364d380ae33d1107dd6693ce60b099ea0826aba551a61fc3033b2ea6c6808ef67aa367eac29802cae5e30
+  data.tar.gz: 5160f0113df885f7ec1597b18eaee70420d82eb0cc11b66d54ee7bb5642f7e95224b1a33c97ced6d75bd89ad6b061627e4a518811a828bbc10c6d66cfbcb4194

data/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 Nothing so far
 
+## 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
+* Simple /healthz route e.g. for deployments on render.com
+* Deploy templates for render.com
+
+#### Changes
+* Switch from httparty to httpx
+
 ## 0.3.1
 
 #### Fixes

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
 
@@ -302,13 +303,13 @@ overmind start
 
 ## Request
 
-To query the **app service**, you can either use the bundled [HTTParty](https://rubygems.org/gems/httparty) gem or the following convenience wrapper:
+To query the **app service**, you can either use the bundled [HTTPX](https://rubygems.org/gems/httpx) gem or the following convenience wrapper:
 
 ```ruby
-response = Rodbot.request('/time', query: { zone: 'UTC' })
+response = Rodbot.request('/time', params: { zone: 'UTC' })
 ```
 
-This uses the default `method: :get` and the default `timeout: 10` seconds, it returns an instance of [HTTParty::Response](https://www.rubydoc.info/gems/httparty/HTTParty/Response):
+This uses the default `method: :get` and the default `timeout: 10` seconds, it returns an instance of [HTTPX::Response](https://www.rubydoc.info/gems/httpx/HTTPX/Response):
 
 ```ruby
 response.code   # => 200

data/checksums/rodbot-0.3.2.gem.sha512

@@ -0,0 +1 @@
+3704bffdb0e27a9544bbdc7538051a9253eeefe81bbbfeea14e1f486e36c701ae200a1b6da151306a96d8e8ccb154236cf18ce4cb27821cd42cbc165a6bc79e6

data/checksums/rodbot-0.3.3.gem.sha512

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

data/lib/rodbot/generator.rb

@@ -22,7 +22,7 @@ module Rodbot
   class Generator
 
     # Glob to filter relevant template files
-    GLOB = "**/{*,.ruby-version,.gitignore,.keep}"
+    GLOB = "**/{*,.ruby-version*,.gitignore,.keep}"
 
     # Colors used by +info+ to color part of the output
     TAG_COLORS = {
@@ -38,8 +38,9 @@ module Rodbot
 
     # Print the interpolated template to STDOUT
     def display
+      puts
       each_template_path do |template_path, target_path, content|
-        puts "# #{target_path}", (content || template_path.read)
+        puts "### #{target_path} ###", (content || template_path.read), nil
       end
     end
 

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

@@ -57,10 +57,10 @@ module Rodbot
           server = TCPServer.new(*bind)
           loop do
             Thread.start(server.accept) do |remote|
-              body = remote.gets("\x04")
+              md = remote.gets("\x04").chop
               remote.close
-              body.force_encoding('UTF-8')
-              room.send_html body.md_to_html
+              md.force_encoding('UTF-8')
+              room.send_html md.psub(placeholders).md_to_html
             end
           end
         end
@@ -71,21 +71,20 @@ module Rodbot
 
         def on_message(message)
           if message.content[:msgtype] == 'm.text' && message.content[:body].start_with?('!')
-            html = 'pong' if message.content[:body] == '!ping'
-            html ||= reply_to(message)
-            room.send_html(html)
+            room.send_html(reply_to(message))
           end
         end
 
         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/relay.rb

@@ -39,10 +39,14 @@ module Rodbot
           server = TCPServer.new(*bind)
           loop do
             Thread.start(server.accept) do |remote|
-              body = remote.gets("\x04")
+              md = remote.gets("\x04").chop
               remote.close
-              body.force_encoding('UTF-8')
-              client.web_client.chat_postMessage(channel: channel_id, text: body, as_user: true)
+              md.force_encoding('UTF-8')
+              client.web_client.chat_postMessage(
+                channel: channel_id,
+                text: md_to_slack_text(md.psub(placeholders)),
+                as_user: true
+              )
             end
           end
         end
@@ -56,23 +60,35 @@ module Rodbot
 
         def on_message(message)
           if message.text.start_with?('!')
-            md = 'pong' if message.text == '!ping'
-            md ||= reply_to(message)
-            client.web_client.chat_postMessage(channel: message.channel, text: md, as_user: true)
+            client.web_client.chat_postMessage(
+              channel: message.channel,
+              text: reply_to(message),
+              as_user: true
+            )
           end
         end
 
         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
 
-        def placeholders(sender)
+        # @see https://api.slack.com/reference/surfaces/formatting
+        def placeholders(locals={})
           {
-            sender: "<@#{sender}>"
+            sender: ("<@#{locals[:sender]}>" if locals[:sender]),
+            everybody: "<!channel>"
           }
         end
 
+        # @see https://api.slack.com/reference/surfaces/formatting
+        def md_to_slack_text(md)
+          md.
+            gsub(/\[(.+?)\]\((.+?)\)/, '<\2|\1>').   # convert links
+            gsub(/^\s*[*-]\s+/, '• ')                # convert bullet lists
+        end
+
       end
     end
   end

data/lib/rodbot/plugins/word_of_the_day/schedule.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'httparty'
+require 'httpx'
 
 module Rodbot
   class Plugins
@@ -24,11 +24,11 @@ module Rodbot
 
       class Today
         def initialize
-          @response = HTTParty.get('https://www.merriam-webster.com/word-of-the-day')
+          @response = HTTPX.with(timeout: { request_timeout: 60 }).get('https://www.merriam-webster.com/word-of-the-day')
         end
 
         def message
-          if @response.success?
+          if @response.status == 200
             "Word of the day: [#{word}](#{url})"
           else
             "Sorry, there was a problem fetching the word of the day."
@@ -38,11 +38,11 @@ module Rodbot
         private
 
         def word
-          @response.body.match(/<h2 class="word-header-txt">(.+?)</).captures.first
+          @response.body.to_s.match(/<h2 class="word-header-txt">(.+?)</).captures.first
         end
 
         def url
-          @response.body.match(/<meta property="og:url" content="(.+?)"/).captures.first
+          @response.body.to_s.match(/<meta property="og:url" content="(.+?)"/).captures.first
         end
       end
 

data/lib/rodbot/rack.rb

@@ -1,6 +1,6 @@
 # frozen-string-literal: true
 
-require 'httparty'
+require 'httpx'
 
 using Rodbot::Refinements
 
@@ -36,12 +36,11 @@ module Rodbot
       # Send request to the app service
       #
       # @param path [String] path e.g. +/help+
-      # @param query [Hash] query hash e.g. +{ search: 'foobar' }+
-      # @param method [Symbol, String] HTTP method
+      # @param params [Hash] params hash e.g. +{ search: 'foobar' }+
       # @param timeout [Integer] max seconds to wait for response
-      # @return [HTTParty::Response]
-      def request(path, query: {}, method: :get, timeout: 10)
-        HTTParty.send(method, Rodbot::Services::App.url.uri_concat(path), query: query, timeout: timeout)
+      # @return [HTTPX::Response]
+      def request(path, params: {}, timeout: 10)
+        HTTPX.with(timeout: { request_timeout: timeout }).get(Rodbot::Services::App.url.uri_concat(path), params: params)
       end
 
     end

data/lib/rodbot/relay.rb

@@ -2,7 +2,7 @@
 
 require 'digest'
 require 'socket'
-require 'httparty'
+require 'httpx'
 
 module Rodbot
 
@@ -84,15 +84,28 @@ module Rodbot
       ]
     end
 
-    # Perform the command on the app using a GET request
+    # Perform the built-in command or fall back to the app using +request+
     #
     # @param command [String] command to perform
     # @param argument [String, nil] optional arguments
     # @return [String] response as Markdown
     def command(command, argument=nil)
-      response = Rodbot.request(command, query: { argument: argument })
-      case response.code
-        when 200 then response.body
+      case command
+        when 'ping' then 'pong'
+        when 'version' then "rodbot-#{Rodbot::VERSION}"
+        else request(command, argument)
+      end
+    end
+
+    # Perform the command on the app using a GET request
+    #
+    # @param command [String] command to perform
+    # @param argument [String, nil] optional arguments
+    # @return [String] response as Markdown
+    def request(command, argument=nil)
+      response = Rodbot.request(command, params: { argument: argument })
+      case response.status
+        when 200 then response.body.to_s
         when 404 then "[[SENDER]] I don't know what do do with `!#{command}`. 🤔"
         else fail
       end

data/lib/rodbot/simulator.rb

@@ -1,7 +1,7 @@
 # frozen-string-literal: true
 
 require 'readline'
-require 'httparty'
+require 'httpx'
 require 'pastel'
 require 'tty-markdown'
 
@@ -16,6 +16,7 @@ module Rodbot
     # @param raw [Boolean] whether to display raw Markdown
     def initialize(sender, raw: false)
       @sender, @raw = sender, raw
+      @relay = Rodbot::Relay.new
       @pastel = Pastel.new
     end
 
@@ -33,17 +34,7 @@ module Rodbot
     def reply_to(message)
       return "(no command given)" unless message.match?(/^!/)
       command, argument = message[1..].split(/\s+/, 2)
-      body = begin
-        response = Rodbot.request(command, query: { argument: argument })
-        case response.code
-          when 200 then response.body
-          when 404 then "[[SENDER]] I've never heard of `!#{command}`, try `!help` instead. 🤔"
-          else fail
-        end
-      rescue
-        "[[SENDER]] I'm having trouble talking to the app. 💣"
-      end
-      text_for body.psub(placeholders)
+      text_for @relay.send(:command, command, argument).psub(placeholders)
     end
 
     def placeholders

data/lib/rodbot/version.rb

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

data/lib/templates/deploy/docker/compose.yaml.gerb

@@ -4,7 +4,7 @@ x-defaults: &defaults
   build:
     context: .
     dockerfile_inline: |
-      FROM ruby:3.2-alpine
+      FROM ruby:[%= RUBY_VERSION.sub(/\.\d+$/, '') %]-alpine
       RUN apk update && apk --no-cache add build-base
       ENV RODBOT_ENV="production"
       ENV RACK_ENV="production"

data/lib/templates/deploy/docker-split/compose.yaml.gerb

@@ -4,7 +4,7 @@ x-defaults: &defaults
   build:
     context: .
     dockerfile_inline: |
-      FROM ruby:3.2-alpine
+      FROM ruby:[%= RUBY_VERSION.sub(/\.\d+$/, '') %]-alpine
       RUN apk update && apk --no-cache add build-base
       ENV RODBOT_ENV="production"
       ENV RACK_ENV="production"

data/lib/templates/deploy/render/render-build.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+echo "--> Checking environment"
+echo "RODBOT_ENV: $RODBOT_ENV"
+echo "RODBOT_PLUGINS: $RODBOT_PLUGINS"
+
+echo "--> Installing bundle"
+bundle config set with $RODBOT_PLUGINS
+bundle install

data/lib/templates/deploy/render/render-start.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+export RODBOT_APP_HOST=0.0.0.0
+bundle exec rodbot start
+sleep infinity

data/lib/templates/deploy/render/render.yaml.gerb

@@ -0,0 +1,19 @@
+services:
+  - type: web
+    name: bot
+    domains:
+      - bot.example.com   # TODO: use a domain name of your own
+    runtime: ruby
+    buildCommand: render-build.sh
+    startCommand: render-start.sh
+    healthCheckPath: /healthz
+    autoDeploy: true
+    envVars:
+      - key: PORT
+        value: 7200
+      - key: PRODUCTION_CREDENTIALS_KEY
+        value:
+      - key: RODBOT_ENV
+        value: production
+      - key: RODBOT_PLUGINS
+        value: matrix   # TODO: update space separated list of plugins

data/lib/templates/deploy/render-split/render-build.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+echo "--> Checking environment"
+echo "RODBOT_ENV: $RODBOT_ENV"
+echo "RODBOT_PLUGINS: $RODBOT_PLUGINS"
+
+echo "--> Installing bundle"
+bundle config set with $RODBOT_PLUGINS
+bundle install

data/lib/templates/deploy/render-split/render-start.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+case 1 in
+  "app")
+    export RODBOT_APP_HOST=0.0.0.0
+    bundle exec rodbot start app
+    ;;
+  "relay")
+    bundle exec rodbot start relay
+    ;;
+  "schedule")
+    bundle exec rodbot start schedule
+    ;;
+  *)
+    echo "Invalid argument"
+    exit 1
+    ;;
+esac

data/lib/templates/deploy/render-split/render.yaml.gerb

@@ -0,0 +1,42 @@
+services:
+  - type: web
+    name: bot-app
+    domains:
+      - bot.example.com   # TODO: use a domain name of your own
+    runtime: ruby
+    buildCommand: render-build.sh
+    startCommand: render-start.sh app
+    healthCheckPath: /healthz
+    autoDeploy: true
+    envVars:
+      - fromGroup: bot
+      - key: PORT
+        value: 7200
+  - type: worker
+    name: bot-relay
+    runtime: ruby
+    buildCommand: render-build.sh
+    startCommand: render-start.sh relay
+    autoDeploy: true
+    envVars:
+      - fromGroup: bot
+  - type: worker
+    name: bot-schedule
+    runtime: ruby
+    buildCommand: render-build.sh
+    startCommand: render-start.sh schedule
+    autoDeploy: true
+    envVars:
+      - fromGroup: bot
+
+envVarGroups:
+  - name: bot
+    envVars:
+      - key: PRODUCTION_CREDENTIALS_KEY
+        value:
+      - key: RODBOT_ENV
+        value: production
+      - key: RODBOT_PLUGINS
+        value: "matrix"   # TODO: update space separated list of plugins
+      - key: RODBOT_APP_URL
+        value: https://bot.example.com   # TODO: use the above service domain name

data/lib/templates/new/.ruby-version.gerb

@@ -0,0 +1 @@
+[%= RUBY_VERSION.sub(/\.\d+$/, '') %]

data/lib/templates/new/app/app.rb

@@ -7,5 +7,6 @@ class App < Roda
     r.root { view :root }
   end
 
+  run :healthz, Routes::Healthz
   run :help, Routes::Help
 end

data/lib/templates/new/app/routes/healthz.rb

@@ -0,0 +1,15 @@
+module Routes
+  class Healthz < App
+
+    route do |r|
+
+      # GET /healthz
+      r.root do
+        response['Content-Type'] = 'text/plain; charset=utf-8'
+        'alive and kicking'
+      end
+
+    end
+
+  end
+end

data/rodbot.gemspec

@@ -46,7 +46,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'dry-credentials', '~> 0'
   spec.add_runtime_dependency 'tty-markdown', '~> 0'
   spec.add_runtime_dependency 'pastel', '~> 0'
-  spec.add_runtime_dependency 'httparty', '~> 0'
+  spec.add_runtime_dependency 'httpx', '~> 1'
   spec.add_runtime_dependency 'puma', '~> 6', '>= 6.2'
   spec.add_runtime_dependency 'roda', '~> 3'
   spec.add_runtime_dependency 'tilt', '~> 2'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rodbot
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Sven Schwyn
@@ -29,7 +29,7 @@ cert_chain:
   kAyiRqgxF4dJviwtqI7mZIomWL63+kXLgjOjMe1SHxfIPo/0ji6+r1p4KYa7o41v
   fwIwU1MKlFBdsjkd
   -----END CERTIFICATE-----
-date: 2023-10-11 00:00:00.000000000 Z
+date: 2023-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -102,19 +102,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: httpx
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
@@ -451,6 +451,8 @@ files:
 - checksums/rodbot-0.2.0.gem.sha512
 - 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
 - doc/rodbot.afphoto
 - doc/rodbot.avif
 - exe/rodbot
@@ -509,12 +511,17 @@ files:
 - lib/templates/deploy/docker/compose.yaml.gerb
 - lib/templates/deploy/procfile-split/Procfile.gerb
 - lib/templates/deploy/procfile/Procfile.gerb
+- lib/templates/deploy/render-split/render-build.sh
+- lib/templates/deploy/render-split/render-start.sh
 - lib/templates/deploy/render-split/render.yaml.gerb
+- lib/templates/deploy/render/render-build.sh
+- lib/templates/deploy/render/render-start.sh
 - lib/templates/deploy/render/render.yaml.gerb
 - lib/templates/new/.gitignore
-- lib/templates/new/.ruby-version
+- lib/templates/new/.ruby-version.gerb
 - lib/templates/new/README.md
 - lib/templates/new/app/app.rb
+- lib/templates/new/app/routes/healthz.rb
 - lib/templates/new/app/routes/help.rb
 - lib/templates/new/app/views/layout.erb
 - lib/templates/new/app/views/root.erb
@@ -563,7 +570,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: Minimalistic framework to build chat bots on top of a Roda backend

data/lib/templates/new/.ruby-version

@@ -1 +0,0 @@
-3.2