ant-bot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a4e8ae082331aa86f94717547ed3ac9a4fd97182269363d3e280260d9cac9971
+  data.tar.gz: 2e19ddde3d123d08770e89c6b3a33ea8f745c365c812df04400e339a95763543
+SHA512:
+  metadata.gz: d80353dd1bb1a77abfefbdbe7855981f119fd32f1de1c967b7644f6f4d98a0953b7c44e6ac4357c44a05c53e89f99237bcd68ad4e8bc59d959cd620048ec8c26
+  data.tar.gz: a3056348c47d1b6d7e4057dbc4dffafff1cd792201ac42d73efe038187fb49ffb1bd193af9bd8954f587f84c4744d1c33a4cdf58fe63d5e9919da8f8c9b89312

data/lib/ant/bot.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'ant/core'
+require 'ant/storage'
+
+require_relative 'bot/base'
+require_relative 'bot/message'
+require_relative 'bot/version'

data/lib/ant/bot/adapters/base.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Ant
+  module Bot
+    # Implements a factory singleton for building bot adapters
+    module Adapter
+      extend Ant::DRY::ResourceInjector
+
+      # builds the abstract adapter
+      def self.from_config(configs)
+        require_relative configs['name']
+        resource(configs['name']).new(configs)
+      end
+    end
+  end
+end

data/lib/ant/bot/adapters/debug.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module Ant
+  module Bot
+    # :nodoc: #
+    module Adapter
+      # :nodoc: #
+      # Wraps a debugging message inside a class.
+      class DebugMessage < Ant::Bot::Message
+        # It receives a string with the raw text and the id of the channel
+        def initialize(text, channel)
+          @text = text
+          @channel = channel
+        end
+
+        # Returns the channel id
+        def channel_id
+          "debug_message__#{@channel}"
+        end
+
+        # Returns the message contents
+        def raw_message
+          @text
+        end
+      end
+
+      # This class simulates a message chat with a user.
+      class Channel
+        # It is build from
+        # an array of raw messages, the name of the channel and the config
+        # to enable debug messages
+        def initialize(messages, name, echo)
+          @state = :open
+          @pending_messages = messages
+          @name = name
+          @echo = echo
+        end
+
+        # Checks if there are messages open or that has not been answered
+        def open?
+          @state == :open
+        end
+
+        # Checks if there are still messages in the channel
+        def empty?
+          @pending_messages.empty?
+        end
+
+        # returns the next message in the buffer
+        def read_message
+          @state = :closed
+          DebugMessage.new(@pending_messages.shift, @name)
+        end
+
+        def send_data(message)
+          return unless @echo
+
+          puts "Sending message to channel: #{@name}"
+          puts message
+        end
+
+        def echo=(toogle)
+          @echo = toogle
+        end
+
+        # receives the answer from the bot
+        def answer(message)
+          send_data(message)
+          @state = :open
+        end
+      end
+
+      ##
+      # This adapter is intended to be used on unit tests and development.
+      class Debug
+        # Exception for stoping the loop of messages
+        class NoMoreMessageException < Ant::Exceptions::AntError
+          def initialize
+            super('There are no messages left')
+          end
+        end
+
+        # It receives a hash with the configurations:
+        # - name: the name of the channel
+        # - channels a key value, where the key is a name and the value the
+        #   list of the messages in the channel.
+        # - echo: a flag to enable debug messages.
+        def initialize(configs)
+          @channels = {}
+          configs['channels'].each do |name, messages|
+            @channels[name] = Channel.new(messages, name, configs['echo'])
+          end
+        end
+
+        # Interface for receiving message
+        def read_message
+          # take the first message from the first open message,
+          # then rotate the array
+          loop do
+            raise NoMoreMessageException if @channels.values.all?(&:empty?)
+
+            msg = @channels.values.find(&:open?)
+            return msg.read_message if msg
+
+            # :nocov: #
+            sleep(1)
+            # :nocov: #
+          end
+        end
+
+        # removes prefix from channel id
+        def channel(name)
+          @channels[name.gsub('debug_message__', '')]
+        end
+
+        # interface for sending messages
+        def send_message(channel_name, contents)
+          channel(channel_name).answer(contents)
+        end
+
+        # interface for sending video
+        def send_video(channel_name, video_url)
+          channel(channel_name).answer("VIDEO: #{video_url}")
+        end
+
+        # interface for sending uadio
+        def send_audio(channel_name, audio_url)
+          channel(channel_name).answer("AUDIO: #{audio_url}")
+        end
+
+        # interface for sending image
+        def send_image(channel_name, image_url)
+          channel(channel_name).answer("IMG: #{image_url}")
+        end
+
+        # changes echo config
+        def echo=(toogle)
+          @channels.each { |_, channel| channel.echo = toogle }
+        end
+      end
+
+      register('debug', Debug)
+    end
+  end
+end

data/lib/ant/bot/adapters/telegram.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Ant
+  module Bot
+    module Adapter
+      # Interface for connecting with telegram api
+      # TODO: Implement this
+      class Telegram
+        def initialize(configs); end
+
+        # Interface for receiving message
+        def read_message
+          raise
+        end
+
+        # interface for sending messages
+        def send_message(_channel, _contents)
+          raise
+        end
+
+        # interface for sending video
+        def send_video(_channel, _video_url)
+          raise
+        end
+
+        # interface for sending uadio
+        def send_audio(_channel, _audio_url)
+          raise
+        end
+
+        # interface for sending image
+        def send_image(_channel, _image_url)
+          raise
+        end
+      end
+    end
+  end
+end

data/lib/ant/bot/base.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+require 'ant/dry/daemon'
+require 'ant/bot/adapters/base'
+require 'ant/storage'
+require_relative 'command_definition'
+
+require 'ant/logger'
+
+module Ant
+  module Bot
+    # Base class for bot implementation. It wraps the threads execution, the
+    # provider and the state storage inside an object.
+    class Base
+      include Ant::Storage::Datasource
+      include Ant::Logger
+      # Configurations needed:
+      # - pool_size: number of threads created in execution
+      # - provider: a configuration for a thread provider.
+      #   See supported adapters
+      # - name: The bot name
+      # - repository: Configurations about the state storage
+      def initialize(configs)
+        @pool_size = configs['pool_size']
+        @provider = Ant::Bot::Adapter.from_config(configs['provider'])
+        @commands = Ant::Bot::CommandDefinition.new
+
+        # TODO: move this to config
+        @repository = Ant::Storage::Repository.from_config(
+          nil,
+          { 'name' => 'json',
+            'schema_name' => configs['name'],
+            'storage' => 'storage/$name',
+            'primary_key' => 'channel_id' },
+          {}
+        )
+        @factory = Ant::Storage::Factory.new(EmptyModel)
+        @factory.register(:default, :json)
+        @factory.register(:json, @repository)
+      end
+
+      # Starts the bot execution, this is a blocking call.
+      def run
+        @pool = Array.new(@pool_size) do
+          # TODO: Create a subclass with the context execution
+          Ant::DRY::Daemon.new(@pool_size, true) do
+            message = @provider.read_message
+            process_message(message)
+          end
+        end
+        # TODO: Implement an interface for killing the process
+        @pool.each(&:run)
+        # :nocov: #
+        @pool.each(&:await)
+        # :nocov: #
+      end
+
+      # Process a single message, this method can be overwriten to enable
+      # more complex implementations of commands. It receives a message object.
+      def process_message(message)
+        run_simple_command!(message)
+      end
+
+      # Executes a command with the easiest definition. It runs a state machine:
+      # - If the message is a command, set the status to asking params
+      # - If the message is a param, stores it
+      # - If the command is ready to be executed, trigger it.
+      def run_simple_command!(message)
+        load_state!(message.channel_id)
+        log_debug('loaded state', message: message.to_h, state: @state.to_h)
+        if message.command?
+          self.command = message
+        else
+          add_param(message)
+        end
+        if command_ready?
+          run_command!
+        else
+          ask_param(next_missing_param)
+        end
+        save_state!
+      end
+
+      # DSL method for adding simple commands
+      def register_command(name, params, &block)
+        @commands.register_command(name, params, block)
+      end
+
+      # Method for triggering command
+      def run_command!
+        current_command_object.execute(current_params)
+      end
+
+      # Checks if the command is ready to be executed
+      def command_ready?
+        cmd = current_command_object
+        cmd.ready?(current_params)
+      end
+
+      # loads parameters from state
+      def current_params
+        @state[:params] || {}
+      end
+
+      # Loads command from state
+      def current_command_object
+        command = @state[:cmd]
+        @commands[command]
+      end
+
+      # returns the current_channel from where the message was sent
+      def current_channel
+        @state[:channel_id]
+      end
+
+      # stores the command into state
+      def command=(cmd)
+        log_debug('Message set as command', command: cmd)
+
+        @state[:cmd] = cmd.raw_message
+        @state[:params] = {}
+      end
+
+      # validates which is the following parameter required
+      def next_missing_param
+        current_command_object.next_missing_param(current_params)
+      end
+
+      # Sends a message to get the next parameter from the user
+      def ask_param(param)
+        log_debug('I\'m going to ask the next param', param: param)
+        @provider.send_message(current_channel,
+                               "I need you to tell me #{param}")
+        @state[:requested_param] = param
+      end
+
+      # Stores a parameter into the status
+      def add_param(value)
+        log_debug('Received new param',
+                  param: @state[:requested_param].to_sym,
+                  value: value)
+
+        @state[:params][@state[:requested_param].to_sym] = value.raw_message
+      end
+
+      # Loads the state from storage
+      def load_state!(channel)
+        @state = load_state(channel)
+      end
+
+      # Private implementation for load message
+      def load_state(channel)
+        @factory.get(channel)
+      rescue Ant::Storage::Exceptions::ObjectNotFound
+        @factory.create(channel_id: channel, params: {})
+      end
+
+      # Saves the state into storage
+      def save_state!
+        @state.store
+      end
+    end
+  end
+end

data/lib/ant/bot/command_definition.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Ant
+  module Bot
+    # Object that wraps a command, it is analogus to a route definition.
+    # it currently only gets a param list, but it will be extended to a more
+    # complex DSL.
+    class Command
+      # Receives a list of params as symbols and the lambda with the block.
+      def initialize(params, block)
+        @params = params
+        @block = block
+      end
+
+      # Calls the block with the params list. Fails if there is a missing param
+      def execute(params)
+        raise 'NotReady' unless ready?(params)
+
+        @block.call(params)
+      end
+
+      # Checks if the params object given contains all the needed values
+      def ready?(current_params)
+        @params.all? { |key| current_params.key?(key) }
+      end
+
+      # Finds the first empty param from the given parameter
+      def next_missing_param(current_params)
+        @params.find { |key| !current_params.key?(key) }
+      end
+    end
+
+    # Wraps a collection of commands.
+    class CommandDefinition
+      def initialize
+        @commands = {}
+      end
+
+      # Stores an operation definition
+      def register_command(name, params, block)
+        @commands[name] = Command.new(params, block)
+      end
+
+      # Returns a command with the name
+      def [](name)
+        @commands[name]
+      end
+    end
+  end
+end

data/lib/ant/bot/message.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'ant/dry/daemon'
+require 'ant/bot/adapters/base'
+
+module Ant
+  module Bot
+    # Base implementation for messages from distinct providers
+    class Message
+      # Converts the messages into a hash
+      def to_h
+        {
+          text: raw_message,
+          channel: channel_id
+        }
+      end
+
+      # Returns true when the received message is a command. Convention states
+      # that messages should start with '/' to be considered commands
+      def command?
+        raw_message.start_with?('/')
+      end
+    end
+  end
+end

data/lib/ant/bot/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ant
+  module Bot
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: ant-bot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gilberto Vargas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ant-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: ant-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: ant-storage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rack-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: Provides a framework for building bots with ruby
+email:
+- tachoguitar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ant/bot.rb
+- lib/ant/bot/adapters/base.rb
+- lib/ant/bot/adapters/debug.rb
+- lib/ant/bot/adapters/telegram.rb
+- lib/ant/bot/base.rb
+- lib/ant/bot/command_definition.rb
+- lib/ant/bot/message.rb
+- lib/ant/bot/version.rb
+homepage: https://github.com/tachomex/ant
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Provides a framework for building bots with ruby
+test_files: []