rodbot 0.4.2 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 731572aaf37dd47b3ca8bdd234e9db1dca540f735fc6031af62a8794d45fd470
-  data.tar.gz: e98a94ef370bd0845749b3182df742cf1870059c75b5abd60800c9643c8e3862
+  metadata.gz: 47f769ca6ea9ef12065fddf0efaf8a0269009654aef1a21fe156a92c07199844
+  data.tar.gz: 6c6fec74a830838687e797dabe1076ec800fddd7f1efb1ea8248a455b80a5819
 SHA512:
-  metadata.gz: c36906cb429ac14617f8e3a80c28cd83620d4ede1d8b3f307f7e8b3f97915c60e8248aa72b1791f58fd32380473976b3286736b8a09fa321311925676cbe4f83
-  data.tar.gz: ef71720cbd4852cc4198b43002757a73e4fcb15b11b5e64b6893477791c608b2e5cccd77a35db95fd4ab72bd1986fbf8c548e2c9ea5a65fa1f87a913e3402c6a
+  metadata.gz: 64dcb382753c7493bad70e24d4fe4e13c12b0388066f16dfc9c491a7d8869254f03d7b2000f910827f477a1a7eaf07e3b1088c46db13db91389bacc11316b25c
+  data.tar.gz: cce4048655798b61cfa1a3724b264ce4d739673771f4f957f5e7878fe469be871de0d28a7b1ab502abf9aefe57f2d8a08e1fcd0d0eb61438b9ca638db8eac3d7

data/.github/workflows/test.yml

@@ -6,7 +6,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        ruby: ['3.0', '3.1', '3.2']
+        ruby: ['3.0', '3.1', '3.2', '3.3']
     name: test (Ruby ${{ matrix.ruby }} on ${{ matrix.os }})
     runs-on: ${{ matrix.os }}
     steps:

data/.ruby-version

@@ -1 +1 @@
-3.2
+3.3

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 Nothing so far
 
+## 0.4.4
+
+#### Changes
+* Adhere to plugin file layout suggestions
+* Support Ruby 3.3
+* Honor `APP_ENV` as an alternative to `RODBOT_ENV`
+
+## 0.4.3
+
+#### Changes
+* Add more languages to the word of the day demo plugin
+
 ## 0.4.2
 
 #### 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
 ----|--------------
@@ -468,6 +468,8 @@ Rodbot.env.production?    # => true
 Rodbot.env.development?   # => false
 ```
 
+You can use the more generic alternative `APP_ENV` as well, however, if `RODBOT_ENV` is defined, it takes precedence over `APP_ENV`.
+
 ## Credentials
 
 In order not to commit secrets to repositories or environment variables, Rodbot bundles the [dry-credentials](https://rubygems.org/gems/dry-credentials) gem and exposes it via the `rodbot credentials` CLI command. The secrets are then available in your code like `Rodbot.credentials.my_secret` and the encrypted files are written to `config/credentials`.
@@ -481,11 +483,12 @@ Rodbot aims to keep its core small and add features via plugins, either built-in
 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)
+[:slack](https://rubydoc.info/github/svoop/rodbot/file/lib/rodbot/plugins/slack/README.slack.md) | yes | relay service for the [Slack communication network](https://slack.com)
 [: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:
 
@@ -601,7 +604,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).
 
@@ -637,7 +640,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.3.gem.sha512

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

data/checksums/rodbot-0.4.4.gem.sha512

@@ -0,0 +1 @@
+263a706d44c8776c413d3800b455249a7c75ed323dc27932ca57d589e13e7da68bc5eb6351beff4efc3cc0dec32d03d7d9c64ee68bfe739426a0f54eccac1229

data/lib/rodbot/env.rb

@@ -27,7 +27,7 @@ module Rodbot
       @root = root ? Pathname(root).realpath : Pathname.pwd
       @tmp = @root.join('tmp')
       @gem = Pathname(__dir__).join('..', '..').realpath
-      @current = ENV['RODBOT_ENV']
+      @current = ENV['RODBOT_ENV'] || ENV['APP_ENV']
       @current = 'development' unless ENVS.include? @current
     end
 

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/lib/adapter.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'adapters/base'
+require_relative 'adapters/merriam_webster'
+require_relative 'adapters/transparent'
+
+module 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

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'httpx'
+
+module 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

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module 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

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module 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

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

@@ -2,12 +2,14 @@
 
 require 'httpx'
 
+require_relative 'lib/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 { ::WordOfTheDay::Adapter.new(_1).message }.compact.join(' / ')
         end
       end
-
     end
   end
 end
+

data/lib/rodbot/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rodbot
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.4
 platform: ruby
 authors:
 - Sven Schwyn
@@ -27,7 +27,7 @@ cert_chain:
   k/QvZU05f6HMYBrPogJgIzHC/C5N/yeE4BVEuBDn+10Zb1iu3aDk8sd0uMgukCY8
   TUmlP5A6NeGdeDJIoLgromAKs+nvI7TWzhQq9ODs51XhxgUFRCvBqUTpjTQigw==
   -----END CERTIFICATE-----
-date: 2023-11-24 00:00:00.000000000 Z
+date: 2024-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -455,6 +455,8 @@ files:
 - 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
+- checksums/rodbot-0.4.4.gem.sha512
 - doc/rodbot.afphoto
 - doc/rodbot.avif
 - exe/rodbot
@@ -500,6 +502,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/lib/adapter.rb
+- lib/rodbot/plugins/word_of_the_day/lib/adapters/base.rb
+- lib/rodbot/plugins/word_of_the_day/lib/adapters/merriam_webster.rb
+- lib/rodbot/plugins/word_of_the_day/lib/adapters/transparent.rb
 - lib/rodbot/plugins/word_of_the_day/schedule.rb
 - lib/rodbot/rack.rb
 - lib/rodbot/refinements.rb
@@ -574,7 +580,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Minimalistic framework to build chat bots on top of a Roda backend