pug-bot 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 130e63accf84439db61edd3da1f0745878a35bf5
-  data.tar.gz: e655cfbcd864bc561b128b0248798a1c8371b62c
+  metadata.gz: bb3da53f3cb80665342a064571021de5697ac955
+  data.tar.gz: 75a403313a896c2d2db1416f985235cd3998163f
 SHA512:
-  metadata.gz: 360bc1589c908f872b249c7e0388b87d50dcbdc0df9e791d84b431f7e3136e0589b37f4632212e3fecdfed8b3f1b8b51ae562729028f0b776f844aa191a5d26d
-  data.tar.gz: d6bfc6fef76beabd1e7ee82ac1df9e9368910138e6cd81e4d81ca415fa69be583050d56ad8ce305efa9027b8f2fc319bd2345392142e5d2beca8804a254b7741
+  metadata.gz: eafbe7a091d4f8fcf7b2b4003a0c2b7697bebf3e81e9968e146b5a22ac68872a8edd1436eefdcdfc922f0e4df100d63b6ac4e1f4c419fe219c923ff909b4e0b6
+  data.tar.gz: 5ab8264be18b53ae4bb3536866a27ecaf94918e24bce8107d561f2789a480c0140f5dd072f1dada31a6b0dc21fe14892f9e49ea86e7235f9e99f71d99caa1814

data/README.md

@@ -1,12 +1,26 @@
 # pug-bot
+[![Gem Version](https://badge.fury.io/rb/pug-bot.svg)](https://badge.fury.io/rb/pug-bot)
+[![Build Status](https://travis-ci.org/ajfigueroa/pug-bot.svg?branch=master)](https://travis-ci.org/ajfigueroa/pug-bot)
 
 An automation framework for repetitive dev tasks
 
+# Background
+
+There were a lot of tasks that I found myself repeating during dev work.
+I wanted something that was device/editor agnostic and could handle multiline arguments with no hassle.
+
+After playing around with the Telegram API, I hacked together a quick Bot to start this automation.
+This is the result of a few weeks of tinkering in hopes of making something more extensible.
+
+This bot was originally designed to work with Telegram but I added support for a command line interface when I wanted something that also worked offline as well.
+
+You can see how I use this framework [here](https://github.com/ajfigueroa/alex-pug-bot).
+
 # Installation
 
 Add the following to your `Gemfile` and then run `bundle install`
 
-```
+```ruby
 gem 'pug-bot'
 ```
 
@@ -57,7 +71,7 @@ end
 Once you've defined your action you just need a way to interact with it.
 There are two ways to interact with pug-bot: Telegram and Terminal.
 
-### Telegram Bot Setup
+## Telegram Bot Setup
 
 To use Telegram we need to first setup a Telegram Bot. Thankfully, Telegram makes this a nice experience. Skip this and the next section if you want to just use Terminal.
 
@@ -88,6 +102,8 @@ end
 Pug::Bot.run
 ```
 
+**Note: If you want to interact with Telegram without a script, you'll need to deploy to a server such as Heroku.**
+
 ## Terminal
 
 To setup Terminal, you just need to specify the type as Terminal
@@ -111,25 +127,24 @@ For the `HelloWorldAction`, that would be `0` as shown below:
 
 ## Telegram
 
-<img src="assets/telegram_example.png" width=60% height=60%>
+![Telegram Example](assets/telegram_example.png)
 
 ## Terminal
 
-<img src="assets/terminal_example.png" width=60% height=60%>
+![Terminal Example](assets/terminal_example.png)
 
 # Hints
 
 Hints can be provided via entering: `help` or `list`.
 
-<img src="assets/terminal_hints.png" width=60% height=60%>
+![Terminal Hints](assets/terminal_hints.png)
 
+# How it works
 
-# Motivation
+This flowchart outlines how an `Action` gets handled by pug-bot
 
-There were a lot of tasks that I found myself repeating during my dev work.
-I wanted to use something that was device/editor agnostic and could handle multiline arguments with no hassle.
-After playing around with the Telegram API, I hacked together a quick Bot to start this automation.
-This is the result of a few weeks of tinkering in hopes of making something more extensible.
+![Action Flow](assets/pug_bot_action_flowchart.png)
+
+# Documentation
 
-If this helps at least one other person work faster then I'll be content.
-Also, I come from an iOS background so forgive my not-so idomatic Ruby.
+Documentation can be generated via `rake document`. You can view the resulting documentation by loading the html files from the newly generated `doc/` folder in a browser.

data/Rakefile

@@ -1,28 +1,15 @@
-# frozen_string_literal: true.
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-require 'pug/version'
-require 'yard'
+RSpec::Core::RakeTask.new(:spec)
 
-desc 'Prepares and installs gem'
-task :prepare do
-  sh %{ gem build pug-bot.gemspec }
-  sh %{ gem install pug-bot-#{Pug::VERSION}.gem }
-end
-
-desc 'Run tests for the gem'
-task :test do
-  sh %{ rspec spec }
-end
+task :default => [:cop, :spec]
 
 desc 'Run Rubocop check for the gem'
 task :cop do
   sh %{ rubocop }
 end
 
-desc 'Verify everything is good before merge'
-task :flightcheck => [:cop, :test] do
-end
-
 desc 'Generate documentation'
 task :document do
   sh %{ yardoc 'lib/**/*.rb' }

data/bin/pug

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'pug'
+require_relative '../example/actions/hello_world_action'
+
+Pug.configure do |config|
+  config.type = Pug::Configuration::TERMINAL
+  config.actions = [HelloWorldAction.new]
+end
+
+Pug::Bot.run

data/lib/pug.rb

@@ -10,7 +10,9 @@ require 'pug/interfaces/client'
 require 'pug/types/result'
 require 'pug/bot'
 require 'pug/configuration'
+require 'pug/help_action'
 require 'pug/keyword_handler'
+require 'pug/list_action'
 require 'pug/message_handler'
 require 'pug/number_parser'
 require 'pug/results'

data/lib/pug/bot.rb

@@ -21,7 +21,7 @@ module Pug
       @handler = MessageHandler.default(actions)
     end
 
-    # Starts the handling all messages received via the Client
+    # Starts the handling of all messages received via the Client
     # @return [void]
     def start
       @client.listen do |message|

data/lib/pug/help_action.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Pug
+  # Lists all the system defined actions
+  class HelpAction < Interfaces::Action
+    # @param actions [Array<Interfaces::Action>]
+    #   system provided actions
+    def initialize(actions)
+      @actions = actions
+    end
+
+    # Action overrides
+
+    # Override of {Interfaces::Action#name}
+    # @return [String]
+    def name
+      ''
+    end
+
+    # Override of {Interfaces::Action#execute}
+    # @return [String]
+    def execute
+      return Strings.no_help_commands if @actions.empty?
+      actions = @actions.map do |action|
+        if action.description.to_s.empty?
+          action.name
+        else
+          "#{action.name} # #{action.description}"
+        end
+      end
+      Strings.help(actions.join("\n"))
+    end
+  end
+end

data/lib/pug/keyword_handler.rb

@@ -5,55 +5,31 @@ require 'set'
 module Pug
   # Responds to keywords that provide hints to the User
   class KeywordHandler
-    # @!group Keywords
-    HELP = 'help'
-    LIST = 'list'
-    # @!endgroup
-
     # @param actions [Array<Interfaces::Action>]
     #   user provided actions
     def initialize(actions)
-      @actions = actions
-      @keywords = Set[HELP, LIST]
-      @enumerator = Action::Enumerator.new
+      list_action = ListAction.new(actions)
+      @keyword_map = {
+        'help' => HelpAction.new([list_action]),
+        'list' => list_action
+      }
     end
 
     # Determines if a given text is a keyword
     # @param text [String] text to test
     # @return [Boolean] if text is a keyword
     def keyword?(text)
-      @keywords.include?(text)
+      @keyword_map.include?(text)
     end
 
     # Runs the command corresponding to text
     # if it is a keyword
     # @param text [String] text to run command for
     # @return [String, nil] output of command or nil
-    def run_command_for_keyword(text)
-      return nil unless keyword?(text)
-      map_keyword_to_command(text)
-    end
-
-    private
-
-    def keywords_excluding_help
-      @keywords.to_a.reject { |keyword| keyword == HELP }
-    end
-
-    def map_keyword_to_command(keyword)
-      return help_response if keyword == HELP
-      return list_response if keyword == LIST
-      nil
-    end
-
-    def help_response
-      commands = keywords_excluding_help.join("\n")
-      Strings.help(commands)
-    end
-
-    def list_response
-      return Strings.no_actions if @actions.empty?
-      @enumerator.names(@actions, true).join("\n")
+    def run_command_for_keyword(keyword)
+      return nil unless keyword?(keyword)
+      command = @keyword_map[keyword]
+      command.execute
     end
   end
 end

data/lib/pug/list_action.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Pug
+  # Lists all the user defined actions
+  class ListAction < Interfaces::Action
+    # @param actions [Array<Interfaces::Action>]
+    #   user provided actions
+    def initialize(actions)
+      @actions = actions
+      @enumerator = Action::Enumerator.new
+    end
+
+    # Action overrides
+
+    # Override of {Interfaces::Action#name}
+    # @return [String]
+    def name
+      'list'
+    end
+
+    # Override of {Interfaces::Action#description}
+    # @return [String]
+    def description
+      Strings.list_description
+    end
+
+    # Override of {Interfaces::Action#execute}
+    # @return [String]
+    def execute
+      return Strings.no_actions if @actions.empty?
+      @enumerator.names(@actions, true).join("\n")
+    end
+  end
+end

data/lib/pug/strings.rb

@@ -32,7 +32,15 @@ module Pug
     end
 
     def self.help(commands)
-      "These are available commands:\n#{commands}"
+      "These are the available commands:\n#{commands}"
+    end
+
+    def self.no_help_commands
+      'There are no available commands.'
+    end
+
+    def self.list_description
+      'Displays all your available pug-bot actions'
     end
   end
 end

data/lib/pug/telegram_client.rb

@@ -43,18 +43,22 @@ module Pug
     private
 
     def send_telegram_message(message)
-      reply_markup = Telegram::Bot::Types::ReplyKeyboardMarkup.new(
-        keyboard: @keyboard_markup || []
-      )
       perform_with_bot do |bot|
         bot.api.send_message(
           chat_id: @chat_id,
           text: message,
-          reply_markup: reply_markup
+          reply_markup: reply_markup,
+          disable_web_page_preview: true
         )
       end
     end
 
+    def reply_markup
+      Telegram::Bot::Types::ReplyKeyboardMarkup.new(
+        keyboard: @keyboard_markup || []
+      )
+    end
+
     def client
       return @client if @client
       raise 'No Telegram token provided' if @token.to_s.empty?

data/lib/pug/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pug
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/pug-bot.gemspec

@@ -1,3 +1,6 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'pug/version'
 
 Gem::Specification.new do |s|
@@ -13,11 +16,14 @@ Gem::Specification.new do |s|
   s.files         = Dir['lib/**/*'] + %w(Gemfile LICENSE README.md Rakefile pug-bot.gemspec)
   s.test_files    = Dir['spec/**/*']
   s.require_paths = ['lib']
+  s.executables   << 'pug'
+
   s.required_ruby_version = '>= 2.3'
 
-  s.add_runtime_dependency 'telegram-bot-ruby', '~> 0.8.6', '>= 0.8.6'
+  s.add_runtime_dependency 'telegram-bot-ruby', '~> 0.8.6'
 
-  s.add_development_dependency 'rspec', '~> 3.7.0', '>= 3.7.0'
-  s.add_development_dependency 'rubocop', '~> 0.53.0', '>= 0.53.0'
-  s.add_development_dependency 'yard', '~> 0.9.2', '>= 0.9.2'
+  s.add_development_dependency 'rspec', '~> 3.7.0'
+  s.add_development_dependency 'rubocop', '~> 0.53.0'
+  s.add_development_dependency 'yard', '~> 0.9.2'
+  s.add_development_dependency 'rake', '~> 10.4.2'
 end

data/spec/lib/pug/bot_spec.rb

@@ -10,12 +10,14 @@ describe Pug::Bot do
       @client = MockClient.new
       action0 = MockAction.new('Action0', false, 'Output0')
       action1 = MockAction.new('Action1', true, 'Output1')
-      @bot = Pug::Bot.new(@client, [action0, action1])
+      @actions = [action0, action1]
+      @bot = Pug::Bot.new(@client, @actions)
     end
 
     it 'should respond to "help" command' do
       @client.enqueue_message('help')
-      expected = Pug::Strings.help('list')
+      list_action = Pug::ListAction.new(@actions)
+      expected = Pug::HelpAction.new([list_action]).execute
       @bot.start
       expect(@client.last_sent_message).to eq(expected)
     end
@@ -53,13 +55,6 @@ describe Pug::Bot do
         @bot.start
         expect(@client.sent_messages).to eq([expected0, expected1])
       end
-
-      it 'should respond to an action call with inputs required' do
-        @client.enqueue_message('1')
-        expected = Pug::Strings.enter_inputs('Action1')
-        @bot.start
-        expect(@client.last_sent_message).to eq(expected)
-      end
     end
 
     describe 'when a command is running' do

data/spec/lib/pug/help_action_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'pug'
+require_relative '../spec_helpers/mock_action'
+
+describe Pug::HelpAction do
+  describe 'execute' do
+    before(:each) do
+      action0 = MockAction.new('Action0', false, 'Output0')
+      action1 = MockAction.new('Action1', true, 'Output1', 'Desc1')
+      @help_action = Pug::HelpAction.new([action0, action1])
+    end
+
+    it 'should display the list of actions' do
+      result = @help_action.execute
+      expected = Pug::Strings.help("Action0\nAction1 # Desc1")
+      expect(result).to eq(expected)
+    end
+
+    it 'should display no actions if none are setup' do
+      help_action = Pug::HelpAction.new([])
+      result = help_action.execute
+      expect(result).to eq(Pug::Strings.no_help_commands)
+    end
+  end
+end

data/spec/lib/pug/keyword_handler_spec.rb

@@ -26,8 +26,8 @@ describe Pug::KeywordHandler 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)
+      @actions = [action0, action1, action2]
+      @handler = Pug::KeywordHandler.new(@actions)
     end
 
     it 'returns nil if text is not a keyword' do
@@ -35,18 +35,19 @@ describe Pug::KeywordHandler do
     end
 
     it 'returns list of keywords if text is help' do
-      expected = Pug::Strings.help('list')
+      list_action = Pug::ListAction.new(@actions)
+      expected = Pug::HelpAction.new([list_action]).execute
       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"
+      expected = Pug::ListAction.new(@actions).execute
       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
+      expected = Pug::ListAction.new([]).execute
       expect(handler.run_command_for_keyword('list')).to eq(expected)
     end
   end

data/spec/lib/pug/list_action_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'pug'
+require_relative '../spec_helpers/mock_action'
+
+describe Pug::ListAction do
+  describe 'execute' do
+    before(:each) do
+      action0 = MockAction.new('Action0', false, 'Output0')
+      action1 = MockAction.new('Action1', true, 'Output1', 'Desc1')
+      @list_action = Pug::ListAction.new([action0, action1])
+    end
+
+    it 'should display the list of actions' do
+      result = @list_action.execute
+      expected = "0: Action0\n1: Action1 # Desc1"
+      expect(result).to eq(expected)
+    end
+
+    it 'should display no actions if none are setup' do
+      list_action = Pug::ListAction.new([])
+      result = list_action.execute
+      expect(result).to eq(Pug::Strings.no_actions)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pug-bot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alex Figueroa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-25 00:00:00.000000000 Z
+date: 2018-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: telegram-bot-ruby
@@ -17,9 +17,6 @@ dependencies:
     - - "~>"
       - !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
@@ -27,9 +24,6 @@ dependencies:
     - - "~>"
       - !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
@@ -37,9 +31,6 @@ dependencies:
     - - "~>"
       - !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
@@ -47,9 +38,6 @@ dependencies:
     - - "~>"
       - !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
@@ -57,9 +45,6 @@ dependencies:
     - - "~>"
       - !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
@@ -67,9 +52,6 @@ dependencies:
     - - "~>"
       - !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
@@ -77,9 +59,6 @@ dependencies:
     - - "~>"
       - !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
@@ -87,12 +66,24 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.2
-    - - ">="
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
 description: 
 email: alexjfigueroa [ at ] gmail [ dot ] com
-executables: []
+executables:
+- pug
 extensions: []
 extra_rdoc_files: []
 files:
@@ -100,6 +91,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/pug
 - lib/pug.rb
 - lib/pug/action/controller.rb
 - lib/pug/action/enumerator.rb
@@ -108,9 +100,11 @@ files:
 - lib/pug/bot.rb
 - lib/pug/clients/factory.rb
 - lib/pug/configuration.rb
+- lib/pug/help_action.rb
 - lib/pug/interfaces/action.rb
 - lib/pug/interfaces/client.rb
 - lib/pug/keyword_handler.rb
+- lib/pug/list_action.rb
 - lib/pug/message_handler.rb
 - lib/pug/number_parser.rb
 - lib/pug/results.rb
@@ -125,7 +119,9 @@ files:
 - spec/lib/pug/bot_spec.rb
 - spec/lib/pug/clients/factory_spec.rb
 - spec/lib/pug/configuration_spec.rb
+- spec/lib/pug/help_action_spec.rb
 - spec/lib/pug/keyword_handler_spec.rb
+- spec/lib/pug/list_action_spec.rb
 - spec/lib/pug/message_handler_spec.rb
 - spec/lib/pug/number_parser_spec.rb
 - spec/lib/pug/types/result_spec.rb
@@ -159,9 +155,11 @@ 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/help_action_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/list_action_spec.rb
 - spec/lib/pug/action/enumerator_spec.rb
 - spec/lib/pug/action/controller_spec.rb
 - spec/lib/pug/message_handler_spec.rb