pug-bot 0.1.0

data/spec/lib/pug/configuration_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'pug'
+
+describe Pug::Configuration do
+  describe 'initialize' do
+    it 'should default to terminal if type is nil' do
+      config = Pug::Configuration.new
+      expect(config.type).to eq(Pug::Configuration::TERMINAL)
+    end
+  end
+
+  describe 'validate' do
+    before(:each) { @config = Pug::Configuration.new }
+
+    it 'should raise an error if type is not valid' do
+      @config.type = 100
+      expect { @config.validate }.to raise_error(RuntimeError)
+    end
+
+    it 'should raise an error if telegram type and missing token' do
+      @config.type = Pug::Configuration::TELEGRAM
+      @config.chat_id = '123'
+      expect { @config.validate }.to raise_error(RuntimeError)
+    end
+
+    it 'should raise an error if telegram type and missing chat_id' do
+      @config.type = Pug::Configuration::TELEGRAM
+      @config.token = 'TOKEN'
+      expect { @config.validate }.to raise_error(RuntimeError)
+    end
+
+    it 'should not raise an error for a valid telegram config' do
+      @config.type = Pug::Configuration::TERMINAL
+      @config.chat_id = '123'
+      @config.token = 'TOKEN'
+      @config.actions = []
+      expect { @config.validate }.to_not raise_error
+    end
+
+    it 'should raise an error if actions are nil' do
+      @config.type = Pug::Configuration::TERMINAL
+      expect { @config.validate }.to raise_error(RuntimeError)
+    end
+
+    it 'should not raise an error for a valid terminal config' do
+      @config.type = Pug::Configuration::TERMINAL
+      @config.actions = []
+      expect { @config.validate }.to_not raise_error
+    end
+  end
+end

data/spec/lib/pug/keyword_handler_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'pug'
+require_relative '../spec_helpers/mock_action'
+
+describe Pug::KeywordHandler do
+  describe 'keyword?' do
+    it 'returns false for non-keyword' do
+      handler = Pug::KeywordHandler.new([])
+      expect(handler.keyword?('ALEX')).to be false
+    end
+
+    it 'returns true for help keyword' do
+      handler = Pug::KeywordHandler.new([])
+      expect(handler.keyword?('help')).to be true
+    end
+
+    it 'returns true for list keyword' do
+      handler = Pug::KeywordHandler.new([])
+      expect(handler.keyword?('list')).to be true
+    end
+  end
+
+  describe 'run_command_for_keyword' do
+    before(:each) do
+      action0 = MockAction.new('Test0', false, '', 'About0')
+      action1 = MockAction.new('Test1', false, '')
+      action2 = MockAction.new('Test2', false, '', '')
+      actions = [action0, action1, action2]
+      @handler = Pug::KeywordHandler.new(actions)
+    end
+
+    it 'returns nil if text is not a keyword' do
+      expect(@handler.run_command_for_keyword('Alex')).to be nil
+    end
+
+    it 'returns list of keywords if text is help' do
+      expected = Pug::Strings.help('list')
+      expect(@handler.run_command_for_keyword('help')).to eq(expected)
+    end
+
+    it 'returns list of actions if text is list' do
+      expected = "0: Test0 # About0\n1: Test1\n2: Test2"
+      expect(@handler.run_command_for_keyword('list')).to eq(expected)
+    end
+
+    it 'returns if there are no actions if text is list' do
+      handler = Pug::KeywordHandler.new([])
+      expected = Pug::Strings.no_actions
+      expect(handler.run_command_for_keyword('list')).to eq(expected)
+    end
+  end
+end

data/spec/lib/pug/message_handler_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'pug'
+require_relative '../spec_helpers/mock_action'
+
+describe Pug::MessageHandler do
+  describe 'when there are no actions' do
+    before(:each) do
+      @handler = Pug::MessageHandler.default([])
+    end
+
+    it 'should return a message about lack of actions' do
+      result = @handler.handle('something')
+      expect(result.type).to eq(Pug::Types::Result::ERROR)
+      expect(result.error).to eq(Pug::Strings.no_actions)
+    end
+  end
+
+  describe 'when there are some actions' do
+    before(:each) do
+      action = MockAction.new('Cmd', false, 'Yo')
+      @handler = Pug::MessageHandler.default([action])
+    end
+
+    it 'should return unknown input result for an empty message' do
+      result = @handler.handle('')
+      expect(result.type).to eq(Pug::Types::Result::ERROR)
+      expect(result.error).to eq(Pug::Strings.unknown_input)
+    end
+
+    it 'should return unknown input result for an invalid action message' do
+      result = @handler.handle('-1: An invalid action')
+      expect(result.type).to eq(Pug::Types::Result::ERROR)
+      expect(result.error).to eq(Pug::Strings.unknown_input)
+    end
+
+    it 'should return unable to start commmand for invalid index' do
+      result = @handler.handle('10: Some out of bounds action')
+      expect(result.type).to eq(Pug::Types::Result::ERROR)
+      expect(result.error).to eq(Pug::Strings.unable_to_start_action(10))
+    end
+  end
+
+  describe 'when running a action that does not require input' do
+    before(:each) do
+      action = MockAction.new('Cmd', false, 'Done!')
+      @handler = Pug::MessageHandler.default([action])
+    end
+
+    it 'should return the success output' do
+      result = @handler.handle('0')
+      expect(result.type).to eq(Pug::Types::Result::SUCCESS)
+      expect(result.value.action_name).to eq('Cmd')
+      expect(result.value.value).to eq('Done!')
+    end
+  end
+
+  describe 'when running a action that requires input' do
+    before(:each) do
+      action = MockAction.new('Cmd', true, 'Done!')
+      @handler = Pug::MessageHandler.default([action])
+    end
+
+    it 'should return info result informing that input is needed' do
+      result = @handler.handle('0')
+      expect(result.type).to eq(Pug::Types::Result::INFO)
+      expect(result.value).to eq(Pug::Strings.enter_inputs('Cmd'))
+    end
+
+    it 'should return a success result when input has been received' do
+      @handler.handle('0')
+      result = @handler.handle('Some input now')
+      expect(result.type).to eq(Pug::Types::Result::SUCCESS)
+      expect(result.value.action_name).to eq('Cmd')
+      expect(result.value.value).to eq('Done!')
+    end
+  end
+end

data/spec/lib/pug/number_parser_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'pug/number_parser'
+
+describe Pug::NumberParser do
+  describe 'starts_with_numeric_text?' do
+    it 'returns false if the text does not start with a number' do
+      parser = Pug::NumberParser.new
+      expect(parser.starts_with_numeric_text?('alex')).to be false
+    end
+
+    it 'returns true if the text is 0' do
+      parser = Pug::NumberParser.new
+      expect(parser.starts_with_numeric_text?('0')).to be true
+    end
+
+    it 'returns true if the text is just a number' do
+      parser = Pug::NumberParser.new
+      expect(parser.starts_with_numeric_text?('10')).to be true
+    end
+
+    it 'returns true if text starts with number' do
+      parser = Pug::NumberParser.new
+      expect(parser.starts_with_numeric_text?('1. Alex')).to be true
+    end
+  end
+
+  describe 'number_from_text' do
+    it 'returns nil if the text does not contain a number' do
+      parser = Pug::NumberParser.new
+      expect(parser.number_from_text('Alex')).to be nil
+    end
+
+    it 'returns nil if the text does not start with a number' do
+      parser = Pug::NumberParser.new
+      expect(parser.number_from_text('Alex 10')).to be nil
+    end
+
+    it 'returns the number if the text does start with a number' do
+      parser = Pug::NumberParser.new
+      expect(parser.number_from_text('10. Alex')).to eq(10)
+    end
+  end
+end

data/spec/lib/pug/types/result_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'pug'
+
+describe Pug::Types::Result do
+  describe 'success' do
+    it 'should return a success result' do
+      success = Pug::Types::Result.success('Hello')
+      expect(success.type).to eq(Pug::Types::Result::SUCCESS)
+      expect(success.value).to eq('Hello')
+      expect(success.error).to be nil
+    end
+  end
+
+  describe 'info' do
+    it 'should return an info result' do
+      info = Pug::Types::Result.info('Info')
+      expect(info.type).to eq(Pug::Types::Result::INFO)
+      expect(info.value).to eq('Info')
+      expect(info.error).to be nil
+    end
+  end
+
+  describe 'error' do
+    it 'should return an error result' do
+      error = Pug::Types::Result.error('Oops')
+      expect(error.type).to eq(Pug::Types::Result::ERROR)
+      expect(error.value).to be nil
+      expect(error.error).to eq('Oops')
+    end
+  end
+end

data/spec/lib/spec_helpers/mock_action.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'pug'
+
+class MockAction < Pug::Interfaces::Action
+  attr_accessor :mock_name,
+                :mock_requires_input,
+                :mock_output,
+                :mock_description
+
+  def initialize(
+    name = nil,
+    requires_input = nil,
+    output = nil,
+    description = nil
+  )
+    @mock_name = name || ''
+    @mock_requires_input = requires_input || false
+    @mock_output = output || ''
+    @mock_description = description || ''
+  end
+
+  # Action Interface
+  def name
+    @mock_name
+  end
+
+  def description
+    @mock_description
+  end
+
+  def requires_input?
+    @mock_requires_input
+  end
+
+  def execute(___)
+    @mock_output
+  end
+end

data/spec/lib/spec_helpers/mock_client.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'pug'
+
+class MockClient < Pug::Interfaces::Client
+  attr_accessor :message_queue, :sent_messages
+
+  def initialize
+    @sent_messages = []
+    @message_queue = []
+  end
+
+  # Overrides
+  def listen
+    queue = @message_queue
+    yield queue.shift until queue.empty?
+  end
+
+  def send_message(message)
+    @sent_messages.push(message)
+  end
+
+  # Helpers
+  def enqueue_message(message)
+    @message_queue.push(message)
+  end
+
+  def last_sent_message
+    return nil if @sent_messages.empty?
+    @sent_messages.pop
+  end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: pug-bot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Figueroa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: telegram-bot-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.53.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.53.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.53.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.53.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: 
+email: alexjfigueroa [ at ] gmail [ dot ] com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/pug.rb
+- lib/pug/action/controller.rb
+- lib/pug/action/enumerator.rb
+- lib/pug/action/input.rb
+- lib/pug/action/output.rb
+- lib/pug/bot.rb
+- lib/pug/clients/factory.rb
+- lib/pug/configuration.rb
+- lib/pug/interfaces/action.rb
+- lib/pug/interfaces/client.rb
+- lib/pug/keyword_handler.rb
+- lib/pug/message_handler.rb
+- lib/pug/number_parser.rb
+- lib/pug/results.rb
+- lib/pug/strings.rb
+- lib/pug/telegram_client.rb
+- lib/pug/terminal_client.rb
+- lib/pug/types/result.rb
+- lib/pug/version.rb
+- pug-bot.gemspec
+- spec/lib/pug/action/controller_spec.rb
+- spec/lib/pug/action/enumerator_spec.rb
+- spec/lib/pug/bot_spec.rb
+- spec/lib/pug/clients/factory_spec.rb
+- spec/lib/pug/configuration_spec.rb
+- spec/lib/pug/keyword_handler_spec.rb
+- spec/lib/pug/message_handler_spec.rb
+- spec/lib/pug/number_parser_spec.rb
+- spec/lib/pug/types/result_spec.rb
+- spec/lib/spec_helpers/mock_action.rb
+- spec/lib/spec_helpers/mock_client.rb
+homepage: https://github.com/ajfigueroa/pug-bot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: An automation framework for repetitive dev tasks
+test_files:
+- spec/lib/spec_helpers/mock_action.rb
+- spec/lib/spec_helpers/mock_client.rb
+- spec/lib/pug/clients/factory_spec.rb
+- spec/lib/pug/types/result_spec.rb
+- spec/lib/pug/number_parser_spec.rb
+- spec/lib/pug/configuration_spec.rb
+- spec/lib/pug/action/enumerator_spec.rb
+- spec/lib/pug/action/controller_spec.rb
+- spec/lib/pug/message_handler_spec.rb
+- spec/lib/pug/bot_spec.rb
+- spec/lib/pug/keyword_handler_spec.rb