rodbot 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfce379a5c8a1fa2b8ba390b25c5a3db58406aa2442edc9bb4c5b022bfabe40a
-  data.tar.gz: 4b5ca31f1697ae81d9374b5ab9e0173ea37c391d4cd9e936c7a733b91b14439b
+  metadata.gz: 63507ad988e8bc39e627cfe154e6713be7e64026e50d222bafc828cb3063825b
+  data.tar.gz: cbb4dd2628412ea4b2672e4dfe1f313ff758124a07dfd41082f38e655d5a4ee7
 SHA512:
-  metadata.gz: 7d8c5faff81fd9fc2f2552155fe1f29909d444c4b8321bbb8faf4b3889ab363a56991d68de88fc418b9418d3dbc587851cb0bd9134009ad0a9ee8321927ef668
-  data.tar.gz: b668cbe4c688399f2d4f8bedd355268b4c24d05bfd74dfe50643c3ec93970ebc42c0e87a882135c580587e8badda7f5b9bb0d3a6fe51b478a9e40fa73c0f2124
+  metadata.gz: 0cb3f6d314ffedd6e8e25f33abb967a03837512f3ba35b0cc4d14746fa19ac8b491e53bb6653fa3d4f2a6158764fb377eaa7c94b625fa86b5294fc23f921f1e7
+  data.tar.gz: cd5d8bc13b3d52f40231b5bb57a0872b340e962caf062e5dab80167d2a5cc35afc57619d36359ebdf5bda133296a608ce603039759bd99e3d4a8ccb0bc6be6ed

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 Nothing so far
 
+## 0.4.3
+
+#### Changes
+* Add more languages to the word of the day demo plugin
+
+## 0.4.2
+
+#### Fixes
+* Pass the time zone down to Clockwork
+
 ## 0.4.1
 
 #### Fixes

data/README.md

@@ -17,21 +17,21 @@ Minimalistic yet polyglot framework to build chat bots on top of a Roda backend
 
 ## Table of Contents
 
-[Install](#label-Install) <br>
-[Anatomy](#label-Anatomy) <br>
-&emsp;&emsp;&emsp;[App Service](#label-App-Service) <br>
-&emsp;&emsp;&emsp;[Relay Services](#label-Relay-Services) <br>
-&emsp;&emsp;&emsp;[Schedule Service](#label-Schedule-Service) <br>
-[CLI](#label-CLI) <br>
+[Install](#install) <br>
+[Anatomy](#anatomy) <br>
+&emsp;&emsp;&emsp;[App Service](#app-service) <br>
+&emsp;&emsp;&emsp;[Relay Services](#relay-services) <br>
+&emsp;&emsp;&emsp;[Schedule Service](#schedule-service) <br>
+[CLI](#CLI) <br>
 [Request](#request)<br>
 [Say](#say)<br>
-[Routes and Commands](#label-Routes-and-Commands) <br>
-[Database](#label-Database) <br>
+[Routes and Commands](#routes-and-commands) <br>
+[Database](#database) <br>
 [Environments](#environments) <br>
 [Credentials](#credentials) <br>
-[Plugins](#label-Plugins) <br>
-[Environment Variables](#label-Environment-Variables) <br>
-[Development](#label-Development) <br>
+[Plugins](#plugins) <br>
+[Environment Variables](#environment-variables) <br>
+[Development](#development) <br>
 
 ## Install
 
@@ -53,7 +53,7 @@ rodbot new my_bot
 cd my_bot
 ```
 
-For the bot to be useful at all, you should choose one of the supported [relay service plugins](#label-Plugins). Say, you'd like to interact via Matrix:
+For the bot to be useful at all, you should choose one of the supported [relay service plugins](#plugins). Say, you'd like to interact via Matrix:
 
 ```
 bundle config set --local with matrix
@@ -137,7 +137,7 @@ It loads the following Roda plugins:
 * [unescape_path](http://roda.jeremyevans.net/rdoc/classes/Roda/RodaPlugins/UnescapePath.html)
 * [render](http://roda.jeremyevans.net/rdoc/classes/Roda/RodaPlugins/Render.html)
 
-It loads the following Roda extensions provided by Rodbot:
+It also loads the following Roda extension provided by Rodbot:
 
 * Shortcut `r.arguments` for `r.params['arguments']`
 
@@ -159,7 +159,7 @@ port 12345
 
 #### Commands
 
-All top level GET requests such as `GET /foobar` are commands and therefore are accessible by relays, for instance using `!foobar` on Matrix.
+All top level GET requests such as `GET /foobar` are commands and therefore accessible by relays, for instance using `!foobar` on Matrix.
 
 Responses have to be either of the following content types:
 
@@ -168,7 +168,7 @@ Responses have to be either of the following content types:
 
 Please note that the Markdown might get stripped on communication networks which feature only limited or no support for Markdown.
 
-The response may contain special tags which have to be replace appropriately by the corresponding **relay service**:
+The response may contain special tags which have to be replaced appropriately by the corresponding **relay service**:
 
 Tag | Replaced with
 ----|--------------
@@ -211,7 +211,11 @@ The **schedule service** is a [Clockwork process](https://github.com/Rykian/cloc
 
 It's a good idea to have the **app service** do the heavy lifting while the schedule simply fires the corresponding HTTP request.
 
-A word on time zones since they are particularly important for schedules: Automatic discovery of the local time zone and DST status is rather unreliable. Therefore, Rodbot expects you to set the time zone in `config/rodbot.rb` using `time_zone`. See `ls /usr/share/zoneinfo` for valid values. To correctly handle DST, you should use geographical zones like `Europe/Paris` rather than technical zones like `CET`. If `time_zone` is not defined, the environment variable `TZ` is read instead. And if `TZ` isn't set neither, Rodbot falls back to `Etc/UTC`.
+A word or two on time zones since they are particularly important for schedules:
+
+Automatic discovery of the local time zone and DST status is rather unreliable. Therefore, Rodbot expects you to set the time zone in `config/rodbot.rb` using `time_zone`. See `ls /usr/share/zoneinfo` for valid values. To correctly handle DST, you should use geographical zones like `Europe/Paris` rather than technical zones like `CET`. If `time_zone` is not defined, the environment variable `TZ` is read instead. And if `TZ` isn't set neither, Rodbot falls back to `Etc/UTC`.
+
+Also, make sure the [time zone data is available](https://tzinfo.github.io) where you deploy your bot to. The [official Alpine-based Ruby images](https://hub.docker.com/_/ruby) for instance doesn't come with it preinstalled, so you either have to `RUN apk add --no-cache tzdata` in the Dockerfile or add the [tzinfo-data gem](https://rubygems.org/gems/tzinfo-data) to the bundle for `TZ` to have any effect at all.
 
 ## CLI
 
@@ -478,10 +482,10 @@ Name | Dependencies | Description
 -----|--------------|------------
 [:matrix](https://rubydoc.info/github/svoop/rodbot/file/lib/rodbot/plugins/matrix/README.matrix.md) | yes | relay service for the [Matrix communication network](https://matrix.org)
 [:otp](https://rubydoc.info/github/svoop/rodbot/file/lib/rodbot/plugins/otp/README.otp.md) | yes | guard commands with one-time passwords
-[:gitlab_webhook](ttps://rubydoc.info/github/svoop/rodbot/file/lib/rodbot/plugins/gitlab_webhook/README.gitlab_webhook.md) | no | event announcements from [GitLab](https://gitlab.com)
-[:github_webhook](ttps://rubydoc.info/github/svoop/rodbot/file/lib/rodbot/plugins/github_webhook/README.github_webhook.md) | no | event announcements from [GitHub](https://github.com)
+[:gitlab_webhook](https://rubydoc.info/github/svoop/rodbot/file/lib/rodbot/plugins/gitlab_webhook/README.gitlab_webhook.md) | no | event announcements from [GitLab](https://gitlab.com)
+[:github_webhook](https://rubydoc.info/github/svoop/rodbot/file/lib/rodbot/plugins/github_webhook/README.github_webhook.md) | no | event announcements from [GitHub](https://github.com)
 [:hal](https://rubydoc.info/github/svoop/rodbot/file/lib/rodbot/plugins/hal/README.hal.md) | no | feel like Dave (demo)
-[:word_of_the_day](ttps://rubydoc.info/github/svoop/rodbot/file/lib/rodbot/plugins/word_of_the_day/README.word_of_the_day.md) | no | word of the day announcements (demo)
+[:word_of_the_day](https://rubydoc.info/github/svoop/rodbot/file/lib/rodbot/plugins/word_of_the_day/README.word_of_the_day.md) | no | word of the day announcements (demo)
 
 You have to install the corresponding Bundler group in case the plugin depends on extra gems. Here's an example for the `:otp` plugin listed above:
 
@@ -597,7 +601,7 @@ end
 
 The `loops` method must returns an array of callables (e.g. a Proc or Method) which will be called when this relay service is started. The loops must trap the `INT` signal.
 
-Proactive messsages require other parts of Rodbot to forward a message directly. To do so, the relay has to implement a TCP socket. This socket must bind to the IP and port you get from the `bind` method which returns an array like `["localhost", 7201]`.
+Proactive messages require other parts of Rodbot to forward a message directly. To do so, the relay has to implement a TCP socket. This socket must bind to the IP and port you get from the `bind` method which returns an array like `["localhost", 7201]`.
 
 For an example, take a look at the [:matrix plugin](https://github.com/svoop/rodbot/tree/main/lib/rodbot/plugins/matrix).
 
@@ -633,7 +637,7 @@ For an example, take a look at the [:word_of_the_day plugin](https://github.com/
 
 #### Toolbox
 
-Before you write a plugin, familiarize yourself with the following bundled helpers:
+Before you write a plugin, familiarise yourself with the following bundled helpers:
 
 * [Rodbot::Refinements](https://www.rubydoc.info/gems/rodbot/Rodbot/Refinements.html) – just a few handy extensions to Ruby core classes
 * [Rodbot::Memoize](https://www.rubydoc.info/gems/rodbot/Rodbot/Memoize.html) – environment-aware memoization for method return values

data/checksums/rodbot-0.4.2.gem.sha512

@@ -0,0 +1 @@
+f6c9c9fd62c5b0c22400fc958198c6d34b8d9b01242b8f7d028fe8622c8c2e8ba955fce7071e05ef0ea3a49e1559954856e21113b1a623c0efd7ed884400a4cc

data/checksums/rodbot-0.4.3.gem.sha512

@@ -0,0 +1 @@
+909cbacb1a78772d5da56bfb4f1ed391fd43e5c9d2abfb347332e7d5933b3cf1afc4ee11cb6fdc1cc5cb61e2f187d3e700f7a66648f8c1facd78201c68e553e2

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

@@ -11,3 +11,30 @@ plugin :word_of_the_day do
   time '10:00'
 end
 ```
+
+By default, the English word of the day from Merriam-Webster is used, but you can [select another language from Transparent](https://www.transparent.com/word-of-the-day/):
+
+```ruby
+plugin :word_of_the_day do
+  time '10:00'
+  languages %w(French)
+end
+```
+
+You can also select more than one language:
+
+```ruby
+plugin :word_of_the_day do
+  time '10:00'
+  languages %w(English French Swedish)
+end
+```
+
+Given the above, the word of the day for any given day might look something like this:
+
+```
+Word of the day: foobar (English) / foobâr (French) / foobår (Swedish)
+```
+
+In case the word of the day is not available, the message will contain the missing language struck through.
+

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'adapters/base'
+require_relative 'adapters/merriam_webster'
+require_relative 'adapters/transparent'
+
+module Rodbot
+  class Plugins
+    class WordOfTheDay
+      class Adapter
+        extend Forwardable
+
+        def_delegator :@adapter, :message, :message
+
+        def initialize(language)
+          @language = language
+          @adapter = (language == 'English' ? MerriamWebster : Transparent).new(language)
+        end
+      end
+    end
+  end
+end

data/lib/rodbot/plugins/word_of_the_day/adapters/base.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'httpx'
+
+module Rodbot
+  class Plugins
+    class WordOfTheDay
+      class Adapter
+        class Base
+          attr_reader :language
+
+          def initialize(language)
+            @language = language.downcase
+          end
+
+          def message
+            if word
+              "[#{word}](#{url}) (#{language.capitalize})"
+            else
+              "~~#{language.capitalize}~~"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rodbot/plugins/word_of_the_day/adapters/merriam_webster.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Rodbot
+  class Plugins
+    class WordOfTheDay
+      class Adapter
+        class MerriamWebster < Base
+          private
+
+          def word
+            html.match(/<h2 class="word-header-txt">(.+?)</)&.captures&.first
+          end
+
+          def url
+            "https://www.merriam-webster.com/word-of-the-day/#{today}"
+          end
+
+          private
+
+          def today
+            Time.now.strftime('%F')
+          end
+
+          def html
+            case (response = HTTPX.get(url))
+              in { status: 200 } then response.body.to_s
+              else ''
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rodbot/plugins/word_of_the_day/adapters/transparent.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Rodbot
+  class Plugins
+    class WordOfTheDay
+      class Adapter
+        class Transparent < Base
+          LANGUAGE_CODES = {
+            'arabic' => 'ar',
+            'chinese' => 'zh',
+            'dutch' => 'nl',
+            'esperanto' => 'esp',
+            'french' => 'fr',
+            'german' => 'de',
+            'irish' => 'ga',
+            'italian' => 'it',
+            'japanese' => 'ja',
+            'latin' => 'la',
+            'polish' => 'pl',
+            'portuguese' => 'pt',
+            'russian' => 'ru',
+            'spanish' => 'es'
+          }.freeze
+
+          def word
+            xml.match(/<word>(.+?)</)&.captures&.first
+          end
+
+          def url
+            "https://wotd.transparent.com/widget/?lang=#{language}&date=#{today}"
+          end
+
+          private
+
+          def today
+            Time.now.strftime('%m-%d-%Y')
+          end
+
+          def language_code
+            LANGUAGE_CODES.fetch(language, language)
+          end
+
+          def xml
+            xml_url = "https://wotd.transparent.com/rss/#{today}-#{language_code}-widget.xml"
+            case (response = HTTPX.get(xml_url))
+              in { status: 200 } then response.body.to_s
+              else ''
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,12 +2,14 @@
 
 require 'httpx'
 
+require_relative 'adapter'
+
 module Rodbot
   class Plugins
     class WordOfTheDay
       class Schedule
         def initialize
-          Clockwork.every(1.day, -> { Rodbot.say message }, at: time)
+          Clockwork.every(1.day, -> { Rodbot.say "Word of the day: #{message}" }, at: time)
         end
 
         private
@@ -16,36 +18,15 @@ module Rodbot
           Rodbot.config(:plugin, :word_of_the_day, :time) || '12:00'
         end
 
-        def message
-          Rodbot::Plugins::WordOfTheDay::Today.new.message
-        end
-
-      end
-
-      class Today
-        def initialize
-          @response = HTTPX.with(timeout: { request_timeout: 60 }).get('https://www.merriam-webster.com/word-of-the-day')
+        def languages
+          Rodbot.config(:plugin, :word_of_the_day, :languages) || %w(english)
         end
 
         def message
-          if @response.status == 200
-            "Word of the day: [#{word}](#{url})"
-          else
-            "Sorry, there was a problem fetching the word of the day."
-          end
-        end
-
-        private
-
-        def word
-          @response.body.to_s.match(/<h2 class="word-header-txt">(.+?)</).captures.first
-        end
-
-        def url
-          @response.body.to_s.match(/<meta property="og:url" content="(.+?)"/).captures.first
+          languages.map { Adapter.new(_1).message }.compact.join(' / ')
         end
       end
-
     end
   end
 end
+

data/lib/rodbot/services/schedule.rb

@@ -16,7 +16,10 @@ module Rodbot
 
       def run
         Clockwork.instance_eval do
-          configure { _1[:logger] = Rodbot::Log.logger('schedule') }
+          configure do |config|
+            config[:tz] = Rodbot.config[:time_zone]
+            config[:logger] = Rodbot::Log.logger('schedule')
+          end
           handler { Rodbot::Async.perform(&_1) }
         end
         Rodbot.plugins.extend_schedule

data/lib/rodbot/version.rb

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

data.tar.gz.sig

@@ -1 +1,3 @@
-n�D��J?]T����H`�ƭ���{�H��6h��ߊZ]k&��]��
�����Y�B]gB׍l7+��NJ׫�F��TvO�M���C�=i��
+Q{<��scB�stV?�=��@�f�����d3)���9]�2����U�Z���;Q܄�
q
+^���=�Ҹ��kDB��uC�WvL�<���O�6)]q/Q�{q`�Ry�T
��&�g�&u?�,'�6%��.�r�_��YԊ�F�\����H���$�I�����1bd̸�w�o��G��h%��
+����8 �-�?�no)+������*ۤ�]`7:Z��=�	�V9Ohð�o�ڱ�xpb�

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rodbot
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Sven Schwyn
@@ -27,7 +27,7 @@ cert_chain:
   k/QvZU05f6HMYBrPogJgIzHC/C5N/yeE4BVEuBDn+10Zb1iu3aDk8sd0uMgukCY8
   TUmlP5A6NeGdeDJIoLgromAKs+nvI7TWzhQq9ODs51XhxgUFRCvBqUTpjTQigw==
   -----END CERTIFICATE-----
-date: 2023-11-12 00:00:00.000000000 Z
+date: 2023-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -454,6 +454,8 @@ files:
 - checksums/rodbot-0.3.4.gem.sha512
 - checksums/rodbot-0.4.0.gem.sha512
 - checksums/rodbot-0.4.1.gem.sha512
+- checksums/rodbot-0.4.2.gem.sha512
+- checksums/rodbot-0.4.3.gem.sha512
 - doc/rodbot.afphoto
 - doc/rodbot.avif
 - exe/rodbot
@@ -499,6 +501,10 @@ files:
 - lib/rodbot/plugins/slack/README.slack.md
 - lib/rodbot/plugins/slack/relay.rb
 - lib/rodbot/plugins/word_of_the_day/README.word_of_the_day.md
+- lib/rodbot/plugins/word_of_the_day/adapter.rb
+- lib/rodbot/plugins/word_of_the_day/adapters/base.rb
+- lib/rodbot/plugins/word_of_the_day/adapters/merriam_webster.rb
+- lib/rodbot/plugins/word_of_the_day/adapters/transparent.rb
 - lib/rodbot/plugins/word_of_the_day/schedule.rb
 - lib/rodbot/rack.rb
 - lib/rodbot/refinements.rb

metadata.gz.sig

@@ -1,3 +1 @@
-���J�v�|��X��lC�^c1u�I��J�4��i�b��/��D�g}���n�u�*�'�Z"qZ�U;*�/���<�>�0�!�NɆL�p��$
-…7Ou
-N��Z��J��B�ߤ�D `|�즚k%�r�hq�
+Q�y^!6	��e�[���@�)l�)l��]#��h��y�b��qu�����ɍ^�('���^:��εFWw�Qj�dK!�o۸A˺t$3>i���㦼_ƺ