rodbot 0.1.0

data/lib/rodbot/services/app.rb

@@ -0,0 +1,72 @@
+# frozen-string-literal: true
+
+require 'rack'
+require 'puma'
+require 'roda'
+
+module Rodbot
+  class Services
+    class App
+      include Rodbot::Memoize
+
+      class << self
+        include Rodbot::Memoize
+
+        # URL (including port) to reach the app service locally
+        #
+        # @return [String] URL
+        memoize def url
+          [
+            (ENV['RODBOT_APP_URL'] || 'http://localhost'),
+            Rodbot.config(:port)
+          ].join(':')
+        end
+      end
+
+      def tasks(**)
+        puts "Starting app service on http://#{bind.join(':')}"
+        [method(:run)]
+      end
+
+      private
+
+      def run
+        Dir.chdir(Rodbot.env.root)
+        Puma::Server.new(app, nil, options).tap do |server|
+          server.add_tcp_listener(*bind)
+          server.app = ::Rack::CommonLogger.new(app, logger)
+        end.run.join
+      end
+
+      memoize def bind
+        [
+          (ENV['RODBOT_APP_HOST'] || 'localhost'),
+          Rodbot.config(:port)
+        ]
+      end
+
+      memoize def app
+        ::Rack::Builder.parse_file(Rodbot.env.root.join('config.ru').to_s)
+      end
+
+      def options
+        {
+          lowlevel_error_handler: method(:lowlevel_error_handler),
+          log_writer: Puma::LogWriter.null,
+          min_threads: Rodbot.config(:app, :threads).min,
+          max_threads: Rodbot.config(:app, :threads).max
+        }
+      end
+
+      memoize def logger
+        Rodbot::Log.logger('app')
+      end
+
+      def lowlevel_error_handler(error)
+        logger.error("#{error.message}: #{error.backtrace.first}")
+        [500, {}, ['Oops!']]
+      end
+
+    end
+  end
+end

data/lib/rodbot/services/relay.rb

@@ -0,0 +1,37 @@
+# frozen-string-literal: true
+
+using Rodbot::Refinements
+
+module Rodbot
+  class Services
+    class Relay
+
+      class << self
+        include Rodbot::Memoize
+
+        # URL (including port) to reach the given relay service locally
+        #
+        # @param name [Symbol] relay service
+        # @return [String] URL
+        memoize def url(name)
+          [
+            (ENV["RODBOT_RELAY_URL_#{name.upcase}"] || 'tcp://localhost'),
+            Rodbot.config(:port) + 1 + Rodbot.config(:plugin).keys.index(name)
+          ].join(':')
+        end
+      end
+
+      def tasks(only: nil)
+        Rodbot.plugins.extend_relay
+        extensions = Rodbot.plugins.extensions[:relay]
+        extensions.select! { _1 == only.to_sym } if only
+        fail Rodbot::RelayError, "no matching relay plugin configured" if extensions.none?
+        extensions.map do |name, path|
+          puts "Starting relay service extension #{name} on #{self.class.url(name)}"
+          path.constantize.new.loops
+        end.flatten
+      end
+
+    end
+  end
+end

data/lib/rodbot/services/schedule.rb

@@ -0,0 +1,29 @@
+# frozen-string-literal: true
+
+require 'clockwork'
+require 'active_support/time'
+
+module Rodbot
+  class Services
+    class Schedule
+
+      def tasks(**)
+        puts "Starting schedule service"
+        [method(:run)]
+      end
+
+      private
+
+      def run
+        Clockwork.instance_eval do
+          configure { _1[:logger] = Rodbot::Log.logger('schedule') }
+          handler { Rodbot::Async.perform(&_1) }
+        end
+        Rodbot.plugins.extend_schedule
+        require Rodbot.env.root.join('config', 'schedule')
+        Clockwork.run
+      end
+
+    end
+  end
+end

data/lib/rodbot/services.rb

@@ -0,0 +1,32 @@
+# frozen-string-literal: true
+
+using Rodbot::Refinements
+
+module Rodbot
+
+  # Foundation to run app, relay and schedule services
+  class Services
+    extend Forwardable
+
+    def_delegator :@dispatcher, :run, :run
+    def_delegator :@dispatcher, :interrupt, :interrupt
+
+    def initialize
+      @dispatcher = Rodbot::Dispatcher.new('rodbot')
+    end
+
+    def exist?(service)
+      Rodbot::SERVICES.include? service.to_sym
+    end
+
+    def register(service, extension: nil)
+      fail(Rodbot::ServiceError, "unknown service #{service}") unless exist? service
+      tasks = "rodbot/services/#{service}".constantize.new.tasks(only: extension)
+      tasks.each_with_index do |task, index|
+        name = [service, (index if tasks.count > 1)].compact.join('-')
+        @dispatcher.register(name, &task)
+      end
+    end
+  end
+
+end

data/lib/rodbot/simulator.rb

@@ -0,0 +1,60 @@
+# frozen-string-literal: true
+
+require 'readline'
+require 'httparty'
+require 'pastel'
+require 'tty-markdown'
+
+using Rodbot::Refinements
+
+module Rodbot
+
+  # Simulate a chat client
+  class Simulator
+
+    # @param sender [String] sender to mimick
+    # @param raw [Boolean] whether to display raw Markdown
+    def initialize(sender, raw: false)
+      @sender, @raw = sender, raw
+      @pastel = Pastel.new
+    end
+
+    def run
+      puts nil, "Talking to app on #{Rodbot::Services::App.url} as sender #{@pastel.inverse(@sender)}."
+      puts 'Type commands beginning with "!" or empty line to exit.', nil
+      while (line = Readline.readline("rodbot> ", true)) && !line.empty?
+        puts nil, reply_to(line), nil
+      end
+      puts
+    end
+
+    private
+
+    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)
+    end
+
+    def placeholders
+      {
+        sender: @pastel.inverse(@sender)
+      }
+    end
+
+    def text_for(markdown)
+      @raw ? markdown : TTY::Markdown.parse(markdown, mode: 16).strip
+    end
+
+  end
+end

data/lib/rodbot/version.rb

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

data/lib/rodbot.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+require 'zeitwerk'
+require 'dry/credentials'
+require 'logger'
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect 'cli' => 'CLI'
+%w(rodbot/plugins roda templates).each { loader.ignore "#{__dir__}/#{_1}" }
+loader.setup
+
+# Rodbot foundation
+#
+# Once the Rodbot gem has been required, use +boot+ to spin up the foundation:
+#
+#   Rodbot.boot                          # current directory is root directory
+#   Rodbot.boot(root: '/path/to/root')   # explicit root directory
+#
+# This gives you access to the following shortcuts (in order of loading):
+#
+# * +Rodbot.env+ -> {Rodbot::Env}
+# * +Rodbot.credentials+ -> {Dry::Credentials}
+# * +Rodbot.config+ -> {Rodbot::Config#config}
+# * +Rodbot.plugins+ -> {Rodbot::Plugins}
+# * +Rodbot.db+ -> {Rodbot::Db#db}
+# * +Rodbot.log+ -> {Rodbot::Log#log}
+# * +Rodbot.request+ -> {Rodbot::Rack#request}
+# * +Rodbot.say+ -> {Rodbot::Relay#say}
+module Rodbot
+  include Rodbot::Constants
+  extend Dry::Credentials
+
+  class << self
+    extend Forwardable
+
+    attr_reader :env
+    def_delegator :@config, :config
+    def_delegator :@plugins, :itself, :plugins
+    def_delegator :@db, :itself, :db
+    def_delegator :@log, :log
+    def_delegator 'Rodbot::Rack', :request
+    def_delegator 'Rodbot::Relay', :say
+
+    def boot(root: nil)
+      @env = Rodbot::Env.new(root: root)
+      credentials do
+        env Rodbot.env.current
+        dir ENV['RODBOT_CREDENTIALS_DIR'] || Rodbot.env.root.join('config', 'credentials')
+      end
+      @config = Rodbot::Config.new(Rodbot.env.root.join('config', 'rodbot.rb').read)
+      @plugins = Rodbot::Plugins.new
+      @db = (db = @config.config(:db)) && Rodbot::Db.new(db)
+      @log = Rodbot::Log.new
+    end
+  end
+end
+
+loader.eager_load_namespace(Rodbot::Error)

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

@@ -0,0 +1,37 @@
+version: "3.9"
+
+x-defaults: &defaults
+  build:
+    context: .
+    dockerfile_inline: |
+      FROM ruby:3.2-alpine
+      RUN apk update && apk --no-cache add build-base
+      ENV RODBOT_ENV="production"
+      ENV RACK_ENV="production"
+      ENV RACK_ROOT="/var/www"
+      ENV TZ="[%= timezone %]"
+      RUN mkdir -p /var/www
+      WORKDIR /var/www
+      COPY . .
+      COPY .bundle /usr/local/bundle
+      RUN bundle config set without "development test" && \
+        bundle install --jobs 20 --retry 5
+  environment:
+    - RODBOT_APP_HOST=0.0.0.0
+    - PRODUCTION_CREDENTIALS_KEY
+  restart: "unless-stopped"
+
+services:
+  rodbot:
+    <<: *defaults
+    command: "sh -c 'bundle exec rodbot start && sleep infinity'"
+    ports:
+      - "[%= Rodbot.config(:app, :port) %]"
+
+networks:
+  default:
+    driver: "bridge"
+    ipam:
+      driver: "default"
+      config:
+        - subnet: "172.16.72.0/24"

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

@@ -0,0 +1,52 @@
+version: "3.9"
+
+x-defaults: &defaults
+  build:
+    context: .
+    dockerfile_inline: |
+      FROM ruby:3.2-alpine
+      RUN apk update && apk --no-cache add build-base
+      ENV RODBOT_ENV="production"
+      ENV RACK_ENV="production"
+      ENV RACK_ROOT="/var/www"
+      ENV TZ="[%= timezone %]"
+      RUN mkdir -p /var/www
+      WORKDIR /var/www
+      COPY . .
+      COPY .bundle /usr/local/bundle
+      RUN bundle config set without "development test" && \
+        bundle install --jobs 20 --retry 5
+  environment:
+    - RODBOT_APP_HOST=0.0.0.0
+    - RODBOT_APP_URL=http://app
+    - RODBOT_RELAY_HOST=0.0.0.0
+[% relay_extensions.each do |name, _| -%]
+    - RODBOT_RELAY_URL_[%= name.upcase %]=tcp://relay-[%= name %]
+[% end -%]
+    - PRODUCTION_CREDENTIALS_KEY
+  restart: "unless-stopped"
+
+services:
+  app:
+    <<: *defaults
+    command: "bundle exec rodbot start app"
+    ports:
+      - "[%= Rodbot.config(:app, :port) %]"
+  schedule:
+    <<: *defaults
+    command: "bundle exec rodbot start schedule"
+[% relay_extensions.each do |name, port| -%]
+  relay-[%= name %]:
+    <<: *defaults
+    command: "bundle exec rodbot start relay [%= name %]"
+    expose:
+      - [%= port %]
+[% end -%]
+
+networks:
+  default:
+    driver: "bridge"
+    ipam:
+      driver: "default"
+      config:
+        - subnet: "172.16.72.0/24"

data/lib/templates/deploy/procfile/Procfile.gerb

@@ -0,0 +1 @@
+rodbot: bundle exec rodbot start

data/lib/templates/deploy/procfile-split/Procfile.gerb

@@ -0,0 +1,5 @@
+app: bundle exec rodbot start app
+schedule: bundle exec rodbot start schedule
+[% relay_extensions.each do |name, port| -%]
+relay_[%= name %]: bundle exec rodbot start relay [%= name %]
+[% end -%]

data/lib/templates/new/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sven Schwyn
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/templates/new/README.md

@@ -0,0 +1,4 @@
+# {{NAME}}
+
+Your friendly neighbourhood bot.
+

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

@@ -0,0 +1,11 @@
+class App < Roda
+  plugin :rodbot
+
+  route do |r|
+    r.multi_run
+    r.public
+    r.root { view :root }
+  end
+
+  run :help, Routes::Help
+end

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

@@ -0,0 +1,19 @@
+module Routes
+  class Help < App
+
+    route do |r|
+
+      # GET /help
+      r.root do
+        response['Content-Type'] = 'text/markdown; charset=utf-8'
+        <<~END
+          [[SENDER]] I'm Rodbot, what can I do for you today?
+
+          * `!ping` – check whether I'm listening
+        END
+      end
+
+    end
+
+  end
+end

data/lib/templates/new/app/views/layout.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>title</title>
+    <link rel="stylesheet" href="/assets/stylesheets/base.css">
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/lib/templates/new/app/views/root.erb

@@ -0,0 +1,5 @@
+<main>
+  <a href="https://github.com/svoop/rodbot">
+    <img src="/assets/images/rodbot.avif">
+  </a>
+</main>

data/lib/templates/new/config/rodbot.rb

@@ -0,0 +1,8 @@
+name 'Rodbot'
+timezone 'Etc/UTC'
+
+plugin :hal
+
+plugin :word_of_the_day do
+  time '10:00'
+end

data/lib/templates/new/config/schedule.rb

@@ -0,0 +1,5 @@
+# Regular jobs performed asynchronously at a given time
+module Clockwork
+  # every 1.hour, -> { Rodbot.say 'Ping!' }
+  # every 1.day, -> { Rodbot.say 'Time for a cup of tea!' }, at: '16:00'
+end

data/lib/templates/new/config.ru

@@ -0,0 +1,3 @@
+require 'rodbot'
+
+Rodbot::Rack.boot(self)

data/lib/templates/new/gems.locked

@@ -0,0 +1,104 @@
+PATH
+  remote: ../../..
+  specs:
+    rodbot (0.1.0.pre1)
+      clockwork (~> 3)
+      debug
+      dry-cli (~> 1)
+      dry-credentials (~> 0)
+      httparty (~> 0)
+      kramdown (~> 2)
+      kramdown-parser-gfm (~> 1)
+      matrix_sdk (~> 2)
+      pastel (~> 0)
+      puma (~> 6, >= 6.2)
+      roda (~> 3)
+      rotp (~> 6)
+      sucker_punch (~> 3)
+      tilt (~> 2)
+      tty-markdown (~> 0)
+      zeitwerk (~> 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    clockwork (3.0.2)
+      activesupport
+      tzinfo
+    concurrent-ruby (1.2.2)
+    debug (1.8.0)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    dry-cli (1.0.0)
+    dry-credentials (0.1.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.6.4)
+      reline (>= 0.3.0)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    little-plugger (1.1.4)
+    logging (2.3.1)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.14)
+    matrix_sdk (2.8.0)
+      logging (~> 2)
+    mini_mime (1.1.2)
+    minitest (5.18.0)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    nio4r (2.5.8)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    puma (6.2.0)
+      nio4r (~> 2.0)
+    rack (3.0.7)
+    reline (0.3.3)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    roda (3.66.0)
+      rack
+    rotp (6.2.2)
+    rouge (4.1.0)
+    strings (0.2.1)
+      strings-ansi (~> 0.2)
+      unicode-display_width (>= 1.5, < 3.0)
+      unicode_utils (~> 1.4)
+    strings-ansi (0.2.0)
+    sucker_punch (3.1.0)
+      concurrent-ruby (~> 1.0)
+    tilt (2.1.0)
+    tty-color (0.6.0)
+    tty-markdown (0.7.2)
+      kramdown (>= 1.16.2, < 3.0)
+      pastel (~> 0.8)
+      rouge (>= 3.14, < 5.0)
+      strings (~> 0.2.0)
+      tty-color (~> 0.5)
+      tty-screen (~> 0.8)
+    tty-screen (0.8.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    unicode_utils (1.4.0)
+    zeitwerk (2.6.7)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  rodbot!
+
+BUNDLED WITH
+   2.4.12

data/lib/templates/new/gems.rb

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gem 'rodbot', '~> 0'
+
+group :matrix, optional: true do
+  gem 'matrix_sdk', '~> 2'
+end
+
+group :redis, optional: true do
+  gem 'redis', '~> 5'
+end
+
+group :otp, optional: true do
+  gem 'rotp', '~> 6'
+end

data/lib/templates/new/guardfile.rb

@@ -0,0 +1,9 @@
+clearing :on
+
+guard :minitest do
+  %i(services).each do |dir|
+    watch(%r{^spec/#{dir}/(.+)_spec\.rb})
+    watch(%r{^#{dir}/(.+)\.rb}) { "spec/#{dir}/#{_1[1]}_spec.rb" }
+  end
+  watch(%r{^spec/spec_helper\.rb}) { 'spec' }
+end

data/lib/templates/new/public/assets/stylesheets/base.css

@@ -0,0 +1,18 @@
+main {
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  height: 100vh;
+}
+
+a {
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  width: 50%;
+}
+
+a img {
+  max-width: 100%;
+  height: auto;
+}