rubydium 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c97622609c92a647d42a147d5f6d3b50b8d3f166364839e7457dfa801463677f
-  data.tar.gz: 383f1f95771e399b41b3155b55ae06cf3287005af7250d7bc4b14add9bdb12fa
+  metadata.gz: 8787fccb275711579c29e53c725847948c7b4ff6f1824284a91e5e037bd0768e
+  data.tar.gz: 1650a9f2d7531bd6173a907ac000b3b00f74a1f52c5b6318d283b2ea328f1d9d
 SHA512:
-  metadata.gz: 1ad2ec41e84c6e36b910c5a403bda5e059f825831a9891ed6a5fc50e4d15e8630e9c84ac82425aae8c0f0138c256a8ff7ed44060c966d55112deb6b5aa60fc8b
-  data.tar.gz: efae72abbd1130732908a5832b3b487b238d15abea26c89ca086e234fb2be330f32a2fd4e5e2ec959acb010209e7d4618de9de6926feb006420f0e89555f75e3
+  metadata.gz: 72c52fde7897f448aef03fc3601a677ee2278bb979544d633d3be9aef0c835afbe16ae554d8eb9c7581ef8020eb961e7d0dfc7ab1ddd9e8f573257529cfc324a
+  data.tar.gz: 0e9480b09c9a489b10e34869478fa3f797641619b9843e93c78ca122a2ac279d60819cbfced0a4805e43b83b182aedb6e448338ffb4d3b334e30cb9b6ae359d2

data/.gitignore

@@ -1 +1,3 @@
 rubydium-*.gem
+test.rb
+/temp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -1,7 +1,62 @@
+require: rubocop-rspec
+
 AllCops:
   TargetRubyVersion: 3.1.2
   NewCops: enable
+  Exclude:
+   - test.rb
+
 Layout/LineLength:
   Max: 100
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyleForEmptyBraces: space
+
+Lint/EmptyBlock:
+  Exclude:
+   - spec/rubydium/mixins/command_macros_spec.rb
+
+Metrics/BlockLength:
+  Exclude:
+   - spec/**/*
+
+Metrics/MethodLength:
+  CountAsOne:
+   - array
+   - heredoc
+   - method_call
+   - hash
+
+RSpec/BeNil:
+  EnforcedStyle: be
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/HookArgument:
+  EnforcedStyle: example
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+
+Style/Documentation:
+  AllowedConstants:
+   - ClassMethods
+
+Style/HashSyntax:
+  EnforcedShorthandSyntax: never
+
+Style/IfUnlessModifier:
+  Enabled: false
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/.ruby-version

@@ -1 +1 @@
-3.1.2
+3.2.2

data/Gemfile

@@ -4,8 +4,9 @@ source "https://rubygems.org"
 
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby "~> 3.1", ">= 3.1.2"
-
 gem "pry"
+gem "rspec"
 gem "rubocop"
+gem "rubocop-rspec"
 gem "telegram-bot-ruby"
+gem "async"

data/Gemfile.lock

@@ -2,6 +2,10 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    async (2.3.1)
+      console (~> 1.10)
+      io-event (~> 1.1)
+      timers (~> 4.1)
     axiom-types (0.1.1)
       descendants_tracker (~> 0.0.4)
       ice_nine (~> 0.11.0)
@@ -9,8 +13,11 @@ GEM
     coderay (1.1.3)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
+    console (1.16.2)
+      fiber-local
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.5.0)
     dry-inflector (1.0.0)
     faraday (2.7.2)
       faraday-net_http (>= 2.0, < 3.1)
@@ -18,7 +25,9 @@ GEM
     faraday-multipart (1.0.4)
       multipart-post (~> 2)
     faraday-net_http (3.0.2)
+    fiber-local (1.0.0)
     ice_nine (0.11.2)
+    io-event (1.1.5)
     json (2.6.3)
     method_source (1.0.0)
     multipart-post (2.2.3)
@@ -31,6 +40,19 @@ GEM
     rainbow (3.1.1)
     regexp_parser (2.6.1)
     rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
     rubocop (1.41.1)
       json (~> 2.3)
       parallel (~> 1.10)
@@ -43,6 +65,8 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.24.0)
       parser (>= 3.1.1.0)
+    rubocop-rspec (2.16.0)
+      rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     telegram-bot-ruby (0.23.0)
@@ -51,6 +75,7 @@ GEM
       faraday-multipart (~> 1.0)
       virtus (~> 2.0)
     thread_safe (0.3.6)
+    timers (4.3.5)
     unicode-display_width (2.3.0)
     virtus (2.0.0)
       axiom-types (~> 0.1)
@@ -61,12 +86,12 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  async
   pry
+  rspec
   rubocop
+  rubocop-rspec
   telegram-bot-ruby
 
-RUBY VERSION
-   ruby 3.1.2p20
-
 BUNDLED WITH
    2.3.26

data/README.md

@@ -1 +1,85 @@
-don't read me yet, i'm not ready
+# What it is
+Rubydium is a framework for building Telegram bots.
+Built on top of [telegram-bot-ruby](https://github.com/atipugin/telegram-bot-ruby) API wrapper, it aims to provide tools for building your bots with minimum boilerplate.
+
+It's far from being done, but all the code in the [examples](example/) directory is functional and *mostly* covered with [specs](spec/rubydium/).
+
+# Installation
+CLI tool for creating and setting up new projects is planned. For now:
+
+1. Create your project:
+`mkdir example_bot && cd example_bot`
+2. Install the gem:
+- Add this gem to the Gemfile:
+`bundle init && echo 'gem "rubydium"' >> Gemfile`
+`bundle install`
+- Or install system-wide:
+`gem install rubydium`
+3. Create your main file:
+`touch example_bot.rb`
+4. See the [examples](example/) directory for bot examples.
+
+# Configuring the bot
+There's two main ways to write your config. With a block:
+```ruby
+ExampleBot.configure do |config|
+  config.token = "1234567890:long_alphanumeric_string_goes_here"
+  config.bot_username = "ends_with_bot"
+  config.owner_username = "thats_you"
+  config.privileged_usernames = %w[
+    your_friend your_chat_moderator
+  ]
+end
+```
+Or with a hash:
+```ruby
+ExampleBot.config = {
+  token: "1234567890:long_alphanumeric_string_goes_here",
+  bot_username: "ends_with_bot",
+  owner_username: "thats_you",
+  privileged_usernames: %w[
+    your_friend your_chat_moderator
+  ]
+}
+```
+The hash variant also means you can pass in any valid Ruby hash, regardless of where it comes from. For example, you can set the same values, if you parse
+<details>
+  <summary>a JSON file:</summary>
+
+  `example_bot/config.json`:
+  ```json
+  {
+    "token": "1234567890:long_alphanumeric_string_goes_here",
+    "bot_username": "ends_with_bot",
+    "owner_username": "thats_you",
+    "privileged_usernames": [
+      "your_friend",
+      "your_chat_moderator"
+    ]
+  }
+  ```
+  `example_bot/example_bot.rb`:
+  ```ruby
+  require "json"
+  ExampleBot.config = JSON.load_file("./config.json")
+  ```
+</details>
+
+<details>
+  <summary>or a YAML:</summary>
+
+  `example_bot/config.yaml`
+  ```yaml
+  token: 1234567890:long_alphanumeric_string_goes_here
+  bot_username: ends_with_bot
+  owner_username: thats_you
+  privileged_usernames:
+  - your_friend
+  - your_chat_moderator
+  ```
+  `example_bot/example_bot.rb`:
+  ```ruby
+  require "yaml"
+  ExampleBot.config = YAML.load_file("./config.yaml")
+  ```
+</details>

data/example/example_bot.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "rubydium"
+
+# Your actual logic of handling the updates goes here.
+class ExampleBot < Rubydium::Bot
+  on_every_message :log_message
+
+  on_command "/help", description: "Show help message" do
+    text = help_message
+    send_message(text)
+  end
+
+  on_command "/start", :greet_user, description: "Say hello"
+
+  def log_message
+    puts "Got message from #{@user.first_name}, text: \n#{@text}"
+  end
+
+  def greet_user
+    text = "Hi hello"
+    reply(text)
+  end
+end
+
+ExampleBot.configure do |config|
+  config.token = "1234567890:long_alphanumeric_string_goes_here"
+  config.bot_username = "ends_with_bot"
+  config.owner_username = "thats_you"
+  config.privileged_usernames = %w[
+    your_friend your_chat_moderator
+  ]
+end
+
+ExampleBot.run

data/lib/rubydium/bot.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Rubydium
+  # On every update a new instance of this class is created to handle it.
+  # This is a base class that's meant to be inherited by user's actual bot class,
+  # where actual logic of handling the updates is described.
+  class Bot
+    include Mixins
+
+    COMMAND_REGEXP = %r{\A/}
+
+    def self.run
+      Telegram::Bot::Client.run(config.token) do |client|
+        Async do |task|
+          client.listen do |update|
+            task.async do
+              # Not all `update`s here are messages (`listen` yields `Update#current_message`,
+              # which can be `ChatMemberUpdated` etc.)
+              # TODO: rework to allow for clean handling of other types.
+              if update.is_a? Telegram::Bot::Types::Message
+                new(client, update).handle_update
+              end
+            rescue => e
+              puts e.detailed_message, e.backtrace
+            end
+          end
+        end
+      end
+    end
+
+    def initialize(client, update)
+      @client = client
+      @api = client.api
+      @msg = update
+      @user = @msg.from
+      @chat = @msg.chat
+      @replies_to = @msg.reply_to_message
+      @target = @replies_to&.from
+      @text = @msg.text.to_s
+      @message_id = @msg.message_id
+      @command = get_command(@msg.text)
+      @text_without_command = @text.gsub(@command.to_s, '').gsub(/@#{config.bot_username}\b/, '').strip
+      @text_without_bot_mentions = @text.gsub(/@#{config.bot_username}\b/, '')
+    end
+
+    def handle_update
+      execute_on_every_message
+      execute_on_mention if @text.split(/\s/).first == "@#{config.bot_username}"
+      # execute_on_reply if @target&.username == config.bot_username
+      execute_command
+    end
+
+    private
+
+    def help_message
+      self.class.registered_commands.map { |command, info|
+        "#{command} - #{info[:description]}"
+      }.join("\n")
+    end
+
+    # For example:
+    # "/start asdf", "/start@yourbot", "/start /another", "asdf /start" will all return "/start".
+    def get_command(text)
+      return unless text
+
+      @command = text.split.grep(%r{\A/}).first
+      @command&.delete_suffix("@#{config.bot_username}")
+    end
+  end
+end

data/lib/rubydium/config.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Rubydium
+  class Bot # :nodoc:
+    def self.configure
+      yield config
+    end
+
+    def self.config
+      @config ||= Config.new
+    end
+
+    def self.config=(config_hash)
+      config_hash.each_pair do |key, value|
+        config.public_send("#{key}=", value)
+      end
+    end
+
+    def config
+      self.class.config
+    end
+  end
+
+  # Things that a full-fledged bot probably needs to know.
+  # Not necessary for basic functionality, though.
+  class Config
+    def method_missing(method, ...)
+      if method[-1] == '='
+        self.class.attr_accessor method[0..-2]
+        public_send(method, ...)
+      else
+        super(method, ...)
+      end
+    end
+  end
+end

data/lib/rubydium/mixins/command_macros.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Rubydium
+  module Mixins
+    # Macro-like definitions that describe what actions bot takes
+    # in reaction to messages.
+    module CommandMacros
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def on_mention(method_name=nil, ignore_forwarded: true, &block)
+          @registered_on_mention ||= []
+          action = (method_name || block)
+          raise ArgumentError, "Provide either method name or a block" unless action
+
+          @registered_on_mention << {
+            action: action,
+            ignore_forwarded: ignore_forwarded
+          }
+        end
+
+        def registered_on_mention
+          @registered_on_mention ||= []
+        end
+
+        def on_every_message(method_name=nil, ignore_forwarded: true, &block)
+          @registered_on_every_message ||= []
+          action = (method_name || block)
+          raise ArgumentError, "Provide either method name or a block" unless action
+
+          @registered_on_every_message << {
+            action: action,
+            ignore_forwarded: ignore_forwarded
+          }
+        end
+
+        def registered_on_every_message
+          @registered_on_every_message ||= []
+        end
+
+        def on_command(command, method_name=nil, description: nil, ignore_forwarded: true, &block)
+          @registered_commands ||= {}
+          action = (method_name || block)
+          raise ArgumentError, "Provide either method name or a block" unless action
+
+          @registered_commands.merge!(
+            {
+              command => {
+                action: action,
+                description: description,
+                ignore_forwarded: ignore_forwarded
+              }
+            }
+          )
+        end
+
+        def registered_commands
+          @registered_commands ||= {}
+        end
+      end
+
+      def skip_task(**kwargs)
+        kwargs.each_pair do |task_type, task_name|
+
+        end
+      end
+
+      def execute_on_every_message
+        self.class.registered_on_every_message.each do |action|
+          next if action[:ignore_forwarded] && @msg.forward_date
+          execute_action(action[:action])
+        end
+      end
+
+      def execute_on_mention
+        self.class.registered_on_mention.each do |action|
+          next if action[:ignore_forwarded] && @msg.forward_date
+          execute_action(action[:action])
+        end
+      end
+
+      def execute_command
+        command = self.class.registered_commands[@command]
+        return unless command
+        return if command[:ignore_forwarded] && @msg.forward_date
+
+        action = command[:action]
+
+        execute_action(action)
+      end
+
+      def execute_action(action)
+        case action
+        when Symbol
+          public_send action
+        when Proc
+          instance_exec(&action)
+        end
+      end
+
+      # # Implement @commands
+      # def execute_all_commands
+      #   method_names = self.class.registered_commands.slice(*@commands).values
+      #   method_name.each { |method| self.public_send(method) }
+      # end
+    end
+  end
+end

data/lib/rubydium/mixins/control_flow.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Rubydium
+  module Mixins
+    # These methods encapsulate common logic in control flow structures
+    # a bot will probably have.
+    module ControlFlow
+      def must_be_owner
+        return not_from_owner unless @user.username == config.owner_username
+
+        yield
+      end
+
+      def must_be_reply
+        return not_a_reply unless @replies_to
+
+        yield
+      end
+
+      def must_be_privileged
+        return not_from_privileged unless config.privileged_usernames.include?(@user.username)
+
+        yield
+      end
+
+      private
+
+      # Overridable methods
+      def not_from_owner; end
+
+      def not_a_reply; end
+
+      def not_from_privileged; end
+    end
+  end
+end

data/lib/rubydium/mixins/message_sending.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Rubydium
+  module Mixins
+    # Shorthand methods for sending messages in different ways.
+    module MessageSending
+      def send_message(text)
+        @api.send_message(
+          chat_id: @chat.id,
+          text: text
+        )
+      end
+
+      def send_sticker(sticker, action: nil, **kwargs)
+        chat_action_if_provided(action, :choose_sticker)
+
+        @api.send_sticker(
+          chat_id: @chat.id,
+          sticker: sticker,
+          **kwargs
+        )
+      end
+
+      def chat_action_if_provided(duration, action_name)
+        if duration
+          send_chat_action(action_name)
+          sleep duration if duration.is_a? Numeric
+        end
+      end
+
+      def send_chat_action(action, **kwargs)
+        @api.send_chat_action(
+          chat_id: @chat.id,
+          action: action,
+          **kwargs
+        )
+      end
+
+      def send_video(video, action: nil, **kwargs)
+        chat_action_if_provided(action, :upload_video)
+
+        @api.send_video(
+          chat_id: @chat.id,
+          video: video,
+          **kwargs
+        )
+      end
+
+      def send_photo(photo, action: nil, **kwargs)
+        chat_action_if_provided(action, :upload_photo)
+
+        @api.send_photo(
+          chat_id: @chat.id,
+          photo: photo,
+          **kwargs
+        )
+      end
+
+      def reply(text, **args)
+        @api.send_message(
+          chat_id: @chat.id,
+          reply_to_message_id: @message_id,
+          text: text,
+          **args
+        )
+      end
+
+      def reply_code(text)
+        reply("```\n#{text}```", parse_mode: "Markdown")
+      end
+
+      def reply_to_target(text)
+        @api.send_message(
+          chat_id: @chat.id,
+          reply_to_message_id: @replies_to.message_id,
+          text: text
+        )
+      end
+    end
+  end
+end

data/lib/rubydium/mixins.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "mixins/message_sending"
+require_relative "mixins/command_macros"
+require_relative "mixins/control_flow"
+
+module Rubydium
+  module Mixins # :nodoc:
+    def self.included(base)
+      base.include(
+        MessageSending,
+        CommandMacros,
+        ControlFlow
+      )
+    end
+  end
+end

data/lib/rubydium/version.rb

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

data/lib/rubydium.rb

@@ -1,4 +1,11 @@
 # frozen_string_literal: true
 
-module Rubydium
+require "telegram/bot"
+require "async"
+require_relative "rubydium/mixins"
+require_relative "rubydium/bot"
+require_relative "rubydium/config"
+require_relative "rubydium/version"
+
+module Rubydium # :nodoc:
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubydium
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - bulgakke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-27 00:00:00.000000000 Z
+date: 2023-09-14 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -18,13 +18,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
+- example/example_bot.rb
 - lib/rubydium.rb
+- lib/rubydium/bot.rb
+- lib/rubydium/config.rb
+- lib/rubydium/mixins.rb
+- lib/rubydium/mixins/command_macros.rb
+- lib/rubydium/mixins/control_flow.rb
+- lib/rubydium/mixins/message_sending.rb
 - lib/rubydium/version.rb
 - rubydium.gemspec
 homepage: https://github.com/bulgakke/rubydium
@@ -49,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.21
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: An OO framework for building Telegram bots. That's the plan, at least.