rita 0.1.0 → 5.0.0.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f002b817d2d1f2e8d14e305469539677a58f7eb4cd0b228ac2871ed27da9f5b
-  data.tar.gz: 62488454ffba6eac6db255c30fce2493cb9a4bbd891d2239ea09fc54459132e5
+  metadata.gz: 794929430473fc5c22aaf15d6224e391198e7ff1a86b4ed1470da3333f088a95
+  data.tar.gz: 3c2224e807b35317d5f5471b24d6cdfac1fa2dc1f8019ee26f608da3541c2625
 SHA512:
-  metadata.gz: c5f078432a52addb9a2e62c340dab87add154545bac4be1aef8c12034cecbed5b41fea72a0fdbbb56993a1a7a27bbf82232886b0c70f39f66b8a24dc97a974fe
-  data.tar.gz: ca037a350c53489610153657e88ff538ab2023cebe5fcfea87e0a840d9bc8302b08453d367bd1aa2a537f6a277f3d1d143dd0ee729ec2a5710553f87eb86950a
+  metadata.gz: a9ab511179725535882ba53c851dc12145af192ae0256ee3d295d74f259cc6610f2e6a70ace9394a4021e784b1bac6f89b53d8cf626cf47ce16a5dd9e32d2cb4
+  data.tar.gz: 33b57d7cb945f2db328b63955173e3ad687cf1dd80a919269312979ee26aba7438f09a93308cd970dd8b98fe3e56f02c67e55c35a14837eec49eb46cc9b5ea0f

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea
+lita_config.rb

data/.rubocop.yml

@@ -0,0 +1,51 @@
+AllCops:
+  NewCops: "enable"
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: "with_fixed_indentation"
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: "table"
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: "variable"
+Layout/LineLength:
+  Max: 100
+
+Lint/EmptyClass:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Max: 6
+
+Naming/MethodParameterName:
+  Enabled: false
+Naming/VariableNumber:
+  EnforcedStyle: "snake_case"
+
+Style/Documentation:
+  Enabled: false
+Style/DoubleNegation:
+  Enabled: false
+Style/EachWithObject:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/SpecialGlobalVars:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: "double_quotes"
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: "double_quotes"
+Style/TrailingCommaInArguments:
+  Enabled: false
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.3.6

data/.travis.yml

@@ -0,0 +1,16 @@
+language: "ruby"
+sudo: false
+cache: "bundler"
+matrix:
+  include:
+    - rvm: "3.0"
+  fast_finish: true
+script: "bundle exec rake"
+before_install:
+  - "gem update --system"
+  - "gem update bundler"
+services:
+  - "redis-server"
+if: "type != push OR (tag IS blank AND branch = main)"
+notifications:
+  email: false

data/CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# Contributing to Lita
+
+## Issues
+
+Found a bug in Lita? Open an issue on [GitHub Issues](https://github.com/litaio/lita/issues). For general questions, feedback, and discussion, please visit [Google Groups](https://groups.google.com/group/litaio) or the `#lita.io` channel on the [Freenode IRC network](https://webchat.freenode.net/).
+
+## Pull requests
+
+Interested in contributing to Lita? That's great, and thank you for your interest!
+
+In order to keep Lita's codebase from growing too large, you're encouraged to implement new functionality via a [plugin](https://www.lita.io/plugin-authoring). If you're not able to achieve what you want with a plugin, then a pull request may be in order. Out of respect for your time, open an issue to discuss any non-trivial changes you intend to make before starting to write code. If you are planning a pull request to improve documentation, fix a bug, or improve performance, then feel free to proceed without opening an issue for discussion.
+
+To get your contributions accepted, make sure:
+
+* All the tests pass. Run `rspec`.
+* No code quality warnings are generated by [RuboCop](https://github.com/bbatsov/rubocop). Run `rubocop`.
+* Any new code paths you've added are covered by tests.
+* Any new classes or methods you've added have API documentation compatible with [YARD](https://yardoc.org/). If you've significantly changed the behavior of an existing class or method, you should also update any existing API documentation.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/{LICENSE.txt → LICENSE}

@@ -1,6 +1,4 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 Ben Oakes
+Copyright (c) 2013-2021 Jimmy Cuadra
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,39 +1,32 @@
-# Rita
+# Lita
 
-TODO: Delete this and the text below, and describe your gem
+[![Gem Version](https://badge.fury.io/rb/lita.svg)](https://rubygems.org/gems/lita)
+[![Build Status](https://travis-ci.com/litaio/lita.svg?branch=main)](https://travis-ci.com/litaio/lita)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rita`. To experiment with that code, run `bin/console` for an interactive prompt.
+**Lita** is a chat bot written in [Ruby](https://www.ruby-lang.org/) with persistent storage provided by [Redis](https://redis.io/).
+It uses a plugin system to connect to different chat services and to provide new behavior.
+The plugin system uses the familiar tools of the Ruby ecosystem: [RubyGems](https://rubygems.org/) and [Bundler](https://bundler.io).
 
-## Installation
+Automate your business and have fun with your very own robot companion.
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Documentation
 
-Install the gem and add to the application's Gemfile by executing:
+Please visit [lita.io](https://www.lita.io/) for comprehensive documentation.
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+## Plugins
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+A list of all publicly available Lita plugins is available on the [lita.io plugins page](https://www.lita.io/plugins).
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+The plugins page automatically updates daily with information from RubyGems. See [publishing](https://docs.lita.io/plugin-authoring/#publishing) for more information.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rita. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rita/blob/master/CODE_OF_CONDUCT.md).
+See the [contribution guide](https://github.com/litaio/lita/blob/main/CONTRIBUTING.md).
 
-## License
+## History
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+For a history of releases, see the [Releases](https://github.com/litaio/lita/releases) page.
 
-## Code of Conduct
+## License
 
-Everyone interacting in the Rita project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rita/blob/master/CODE_OF_CONDUCT.md).
+[MIT](https://opensource.org/licenses/MIT)

data/Rakefile

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "minitest/test_task"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
-Minitest::TestTask.create
+RSpec::Core::RakeTask.new
+RuboCop::RakeTask.new
 
-require "standard/rake"
-
-task default: %i[test standard]
+task default: %i[spec rubocop]

data/bin/lita

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler"
+require "lita/cli"
+
+Lita::CLI.start

data/lib/lita/adapter.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require "i18n"
+
+require_relative "configurable"
+require_relative "namespace"
+
+module Lita
+  # Adapters are the glue between Lita's API and a chat service.
+  class Adapter
+    # The names of methods that should be implemented by an adapter.
+    # @since 4.4.0
+    REQUIRED_METHODS = %i[
+      chat_service
+      join
+      part
+      roster
+      run
+      send_messages
+      set_topic
+      shut_down
+    ].freeze
+
+    extend Namespace
+    extend Configurable
+
+    # The instance of {Robot}.
+    # @return [Robot]
+    attr_reader :robot
+
+    class << self
+      # Returns the translation for a key, automatically namespaced to the adapter.
+      # @param key [String] The key of the translation.
+      # @param hash [Hash] An optional hash of values to be interpolated in the string.
+      # @return [String] The translated string.
+      def translate(key, hash = {})
+        I18n.translate("lita.adapters.#{namespace}.#{key}", **hash)
+      end
+
+      alias t translate
+    end
+
+    # @param robot [Robot] The currently running robot.
+    def initialize(robot)
+      @robot = robot
+    end
+
+    # The adapter's configuration object.
+    # @return [Configuration] The adapter's configuration object.
+    # @since 4.0.0
+    def config
+      robot.config.adapters.public_send(self.class.namespace)
+    end
+
+    # @!method chat_service
+    # May return an object exposing chat-service-specific APIs.
+    # @return [Object, nil] The chat service API object, if any.
+    # @abstract This should be implemented by the adapter.
+    # @since 4.6.0
+
+    # @!method join(room_id)
+    # Joins the room with the specified ID.
+    # @param room_id [String] The ID of the room.
+    # @return [void]
+    # @abstract This should be implemented by the adapter.
+    # @since 3.0.0
+
+    # @!method part(room_id)
+    # Parts from the room with the specified ID.
+    # @param room_id [String] The ID of the room.
+    # @return [void]
+    # @abstract This should be implemented by the adapter.
+    # @since 3.0.0
+
+    # @!method roster(room)
+    # Get a list of users that are online in the given room.
+    # @param room [Room] The room to return a roster for.
+    # @return [Array<User>] An array of users.
+    # @abstract This should be implemented by the adapter.
+    # @since 4.4.0
+
+    # @!method run
+    # The main loop. Should connect to the chat service, listen for incoming
+    # messages, create {Message} objects from them, and dispatch them to
+    # the robot by calling {Robot#receive}.
+    # @return [void]
+    # @abstract This should be implemented by the adapter.
+
+    # @!method send_messages(target, strings)
+    # Sends one or more messages to a user or room.
+    # @param target [Source] The user or room to send messages to.
+    # @param strings [Array<String>] An array of messages to send.
+    # @return [void]
+    # @abstract This should be implemented by the adapter.
+
+    # @!method set_topic(target, topic)
+    # Sets the topic for a room.
+    # @param target [Source] The room to change the topic for.
+    # @param topic [String] The new topic.
+    # @return [void]
+    # @abstract This should be implemented by the adapter.
+
+    # @!method shut_down
+    # Performs any clean up necessary when disconnecting from the chat service.
+    # @return [void]
+    # @abstract This should be implemented by the adapter.
+    REQUIRED_METHODS.each do |method|
+      define_method(method) do |*_args|
+        robot.logger.warn(I18n.t("lita.adapter.method_not_implemented", method: method))
+      end
+    end
+
+    # The robot's logger.
+    # @return [::Logger] The robot's logger.
+    # @since 4.0.2
+    def log
+      robot.logger
+    end
+
+    # Formats a name for "mentioning" a user in a group chat. Override this
+    # method in child classes to customize the mention format for the chat
+    # service.
+    # @param name [String] The name to format as a mention name.
+    # @return [String] The formatted mention name.
+    # @since 3.1.0
+    def mention_format(name)
+      "#{name}:"
+    end
+
+    # Runs a block of code concurrently. By default the block is run in a new thread. Override
+    # this method in child classes to customize the mechanism for concurrent code execution.
+    #
+    # @yield A block of code to run concurrently.
+    # @return [void]
+    # @since 5.0.0
+    def run_concurrently(&block)
+      Thread.new(&block)
+    end
+
+    # @see .translate
+    def translate(*args)
+      self.class.translate(*args)
+    end
+
+    alias t translate
+  end
+end

data/lib/lita/adapters/shell.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require "rbconfig"
+
+require "readline"
+
+require_relative "../adapter"
+require_relative "../message"
+require_relative "../source"
+require_relative "../user"
+
+module Lita
+  # A namespace to hold all subclasses of {Adapter}.
+  module Adapters
+    # An adapter that runs Lita in a UNIX shell.
+    class Shell < Adapter
+      config :private_chat, default: false
+
+      def initialize(robot)
+        super
+
+        self.user = User.create(1, name: "Shell User")
+      end
+
+      # rubocop:disable Lint/UnusedMethodArgument
+
+      # Returns the users in the room, which is only ever the "Shell User."
+      # @param room [Room] The room to return a roster for. Not used in this adapter.
+      # @return [Array<User>] The users in the room.
+      # @since 4.4.0
+      def roster(room)
+        [user]
+      end
+
+      # rubocop:enable Lint/UnusedMethodArgument
+
+      # Displays a prompt and requests input in a loop, passing the incoming messages to the robot.
+      # @return [void]
+      def run
+        room = robot.config.adapters.shell.private_chat ? nil : "shell"
+        @source = Source.new(user: user, room: room)
+        puts t("startup_message")
+        robot.trigger(:connected)
+
+        run_loop
+      end
+
+      # Overrides {run_concurrently} to block instead. Since there is no separate UI element for the
+      # user to enter text, we need to wait for all output for the robot before printing the next
+      # input prompt.
+      #
+      # @yield A block of code to run.
+      # @return [void]
+      # @since 5.0.0
+      def run_concurrently(&block)
+        block.call
+      end
+
+      # Outputs outgoing messages to the shell.
+      # @param _target [Source] Unused, since there is only one user in the
+      #   shell environment.
+      # @param strings [Array<String>] An array of strings to output.
+      # @return [void]
+      def send_messages(_target, strings)
+        strings = Array(strings)
+        strings.reject!(&:empty?)
+        unless RbConfig::CONFIG["host_os"] =~ /mswin|mingw/ || !$stdout.tty?
+          strings.map! { |string| "\e[32m#{string}\e[0m" }
+        end
+        puts strings
+      end
+
+      # Adds a blank line for a nice looking exit.
+      # @return [void]
+      def shut_down
+        puts
+      end
+
+      private
+
+      attr_accessor :user
+
+      def build_message(input, source)
+        message = Message.new(robot, input, source)
+        message.command! if robot.config.adapters.shell.private_chat
+        message
+      end
+
+      def normalize_history(input)
+        if input == "" || (Readline::HISTORY.size >= 2 && input == Readline::HISTORY[-2])
+          Readline::HISTORY.pop
+        end
+      end
+
+      def normalize_input(input)
+        input.chomp.strip
+      end
+
+      def read_input
+        input = Readline.readline("#{robot.name} > ", true)
+        # Input read via rb-readline will always be encoded as US-ASCII.
+        # @see https://github.com/ConnorAtherton/rb-readline/blob/9fba246073f78831b7c7129c76cc07d8476a8892/lib/readline.rb#L1
+        input&.dup&.force_encoding(Encoding.default_external)
+      end
+
+      def run_loop
+        exit_keywords = %w[exit quit].freeze
+
+        loop do
+          input = read_input
+          if input.nil?
+            puts
+            break
+          end
+          input = normalize_input(input)
+          normalize_history(input)
+          break if exit_keywords.include?(input)
+
+          robot.receive(build_message(input, @source))
+        end
+      end
+    end
+
+    Lita.register_adapter(:shell, Shell)
+  end
+end

data/lib/lita/adapters/test.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative "../adapter"
+
+module Lita
+  # A namespace to hold all subclasses of {Adapter}.
+  module Adapters
+    # An adapter for testing Lita and Lita plugins.
+    # @since 4.6.0
+    class Test < Adapter
+      # When true, calls to {#run_concurrently} will block the current thread. This is the default
+      # because it's desirable for the majority of tests. It should be set to +false+ for tests
+      # specifically testing asynchrony.
+      config :blocking, types: [TrueClass, FalseClass], default: true
+
+      # Adapter-specific methods exposed through {Robot}.
+      class ChatService
+        def initialize(sent_messages)
+          @sent_messages = sent_messages
+        end
+
+        # An array of recorded outgoing messages.
+        def sent_messages
+          @sent_messages.dup
+        end
+      end
+
+      def initialize(robot)
+        super
+
+        self.sent_messages = []
+      end
+
+      # Adapter-specific methods available via {Robot#chat_service}.
+      def chat_service
+        ChatService.new(sent_messages)
+      end
+
+      # Records outgoing messages.
+      def send_messages(_target, strings)
+        sent_messages.concat(strings)
+      end
+
+      # If the +blocking+ config attribute is +true+ (which is the default), the block will be run
+      # on the current thread, so tests can be written without concern for asynchrony.
+      def run_concurrently(&block)
+        if config.blocking
+          block.call
+        else
+          super
+        end
+      end
+
+      private
+
+      # An array of recorded outgoing messages.
+      attr_accessor :sent_messages
+    end
+
+    Lita.register_adapter(:test, Test)
+  end
+end

data/lib/lita/authorization.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require "redis-namespace"
+
+require_relative "user"
+
+module Lita
+  # Methods for querying and manipulating authorization groups.
+  class Authorization
+    # @param robot [Robot] The currently running robot.
+    def initialize(robot)
+      self.robot = robot
+      self.redis = Redis::Namespace.new("auth", redis: robot.redis)
+    end
+
+    # Adds a user to an authorization group.
+    # @param requesting_user [User] The user who sent the command.
+    # @param user [User] The user to add to the group.
+    # @param group [Symbol, String] The name of the group.
+    # @return [Symbol] :unauthorized if the requesting user is not authorized.
+    # @return [Boolean] true if the user was added. false if the user was
+    #   already in the group.
+    def add_user_to_group(requesting_user, user, group)
+      return :unauthorized unless user_is_admin?(requesting_user)
+
+      add_user_to_group!(user, group)
+    end
+
+    # Adds a user to an authorization group without validating the permissions
+    # of the requesting user.
+    # @param user [User] The user to add to the group.
+    # @param group [Symbol, String] The name of the group.
+    # @return [Boolean] true if the user was added. false if the user was
+    #   already in the group.
+    # @since 4.0.0
+    def add_user_to_group!(user, group)
+      redis.sadd(normalize_group(group), user.id)
+    end
+
+    # Removes a user from an authorization group.
+    # @param requesting_user [User] The user who sent the command.
+    # @param user [User] The user to remove from the group.
+    # @param group [Symbol, String] The name of the group.
+    # @return [Symbol] :unauthorized if the requesting user is not authorized.
+    # @return [Boolean] true if the user was removed. false if the user was
+    #   not in the group.
+    def remove_user_from_group(requesting_user, user, group)
+      return :unauthorized unless user_is_admin?(requesting_user)
+
+      remove_user_from_group!(user, group)
+    end
+
+    # Removes a suer from an authorization group without validating the
+    # permissions of the requesting user.
+    # @param user [User] The user to remove from the group.
+    # @param group [Symbol, String] The name of the group.
+    # @return [Boolean] true if the user was removed. false if the user was
+    #   not in the group.
+    # @since 4.0.0
+    def remove_user_from_group!(user, group)
+      redis.srem(normalize_group(group), user.id)
+    end
+
+    # Checks if a user is in an authorization group.
+    # @param user [User] The user.
+    # @param group [Symbol, String] The name of the group.
+    # @return [Boolean] Whether or not the user is in the group.
+    def user_in_group?(user, group)
+      group = normalize_group(group)
+      return user_is_admin?(user) if group == "admins"
+
+      redis.sismember(group, user.id)
+    end
+
+    # Checks if a user is an administrator.
+    # @param user [User] The user.
+    # @return [Boolean] Whether or not the user is an administrator.
+    def user_is_admin?(user)
+      Array(robot.config.robot.admins).include?(user.id)
+    end
+
+    # Returns a list of all authorization groups.
+    # @return [Array<Symbol>] The names of all authorization groups.
+    def groups
+      redis.keys("*").map(&:to_sym)
+    end
+
+    # Returns a hash of authorization group names and the users in them.
+    # @return [Hash] A map of +Symbol+ group names to {User} objects.
+    def groups_with_users
+      groups.reduce({}) do |list, group|
+        list[group] = redis.smembers(group).map do |user_id|
+          User.find_by_id(user_id)
+        end
+        list
+      end
+    end
+
+    private
+
+    # Ensures that group names are stored consistently in Redis.
+    def normalize_group(group)
+      group.to_s.downcase.strip
+    end
+
+    # @return [Redis::Namespace] A Redis::Namespace for authorization data.
+    attr_accessor :redis
+
+    # @return [Robot] The currently running robot.
+    attr_accessor :robot
+  end
+end