botup 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c603c0ddf02ac224105e1b3a0f9749ba8ed118b
-  data.tar.gz: 84b3c8721dd37268f33cf0e04e176e6ae7539e79
+  metadata.gz: 393408836b80c655ca0281bbba7c8d25ddce2232
+  data.tar.gz: 14ce81b6bae79b350b0593b4f9651c318ce4cdc9
 SHA512:
-  metadata.gz: 1a322d7667d52598815b3b3c4eb51cfee014d853a9c3d5eec100363fbbb882aa694a3e236c34c28f2cc68c9358ad5d2ece2604168c7e644276248d10725f89ad
-  data.tar.gz: 8616548bbd8b66761bb906cff83a0118d4336ed07dd37e73ac4738a2d83e90baef2c40e5b281b1e78383424fe0c1bb30ee623eb1113b4d0852a5778aa17f654c
+  metadata.gz: 7f87ae0e9eb0b1e170f6fe12ef8537c62783ec6e517dedab54d938390b38b189c718c58cd9e6accef4ca6c35b3bd727fe4287974247b3513a31c60c587963543
+  data.tar.gz: abc5c181956d9ecf7a918bec00fa17d0207ea2d51e596a8366b78f3c7e58b97a9c3c3a4229fea957fd5fab48a6a965e1803663118bf08155ff5789ad3d9e7313

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 /.idea
+Gemfile.lock

data/.rubocop.yml

@@ -2,13 +2,6 @@ AllCops:
   Exclude:
     - '.bundle/**/*'
     - 'bin/**/*'
-    - 'config/**/*'
-    - 'db/**/*'
-    - 'lib/tasks/**/*'
-    - 'app/controllers/users/confirmations_controller.rb'
-    - 'app/controllers/users/registrations_controller.rb'
-    - 'lib/extensions/simple_form/inputs/array_input.rb'
-    - 'vendor/assets/**/**/*'
 
 Documentation:
   Enabled: false

data/README.md

@@ -14,41 +14,34 @@ Bootstrap new telegram bot was never so simple!
 
     $ botup my_super_bot # Provide bot name in snake_case
     $ cd my_super_bot && bundle install # Install dependencies
-    
+
 ## What's in the bot?
 
     .
     |____bin
     | |____my_super_bot             # Executable for starting your bot client
-    |____config
-    | |____config.yml               # Config file storing bot token
-    |____Gemfile 
+    |____Gemfile
     |____lib
     | |____my_super_bot
-    | | |____client.rb              # Core telegram bot class; takes token and answer to any command sent
-    | | |____commands_keeper.rb     # Stores all available commands (includes test command by deault); 
-    | | |____commands_manager.rb    # Takes command and handles next step
+    | | |____client.rb              # Telegram client which listens to incomming messages
+    | | |____commands_keeper.rb     # Stores all available commands (includes test command by deault);
+    | | |____commands_manager.rb    # Routes command to the appropriate one from commands_keeper.rb
     | | |____message_parser.rb      # Parses sent message to command and params
-    | | |____messenger.rb           # Handles current chat item and sends output to user
     | |____my_super_bot.rb
-    
-## How to use your bot
 
-- Add your bot's token to **config/config.yml**
+## How to use your bot
+- Obtain bot api key by @BotFather and put it in *.env* file.
 - Add desired methods to **lib/YOUR_BOT_NAME/commands_keeper.rb**. For example, to implement command */today_schedule* just create appropriate method:
 
-    ```
-    def today_schedule
-        Schedule.new(Time.now).call 
+    ```ruby
+    def friday
+      Time.now.friday? ? "Hooray it's friday" : "It's always Friday somewhere."
     end
     ```
-- Start bot:
-    
-    ```$ my_super_bot/bin/my_super_bot```
-- Try it out by sending /test command(or some other command that you have already implemented)
+- Start bot by running executable:
 
-    ![](https://monosnap.com/file/c2WA7eWNmsex9ccf9E50C36Vro17kr.png)
-- Sit back and take a glass of Pina Colada!
+    ```$ my_super_bot/bin/my_super_bot```
+- Try it out by sending /friday command(or some other command that you have already implemented)
 
 ## Contributing
 

data/botup.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'botup/version'
@@ -19,5 +18,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'bundler', '~> 1.16'
 end

data/lib/botup/bin/exec.erb

@@ -6,4 +6,4 @@ Bundler.setup
 
 require '<%= "./lib/#{snake_case_name}" %>'
 
-<%= class_name %>.start_client
+<%= class_name %>.start

data/lib/botup/config/.env

@@ -0,0 +1 @@
+TELEGRAM_BOT_TOKEN=GET_A_TOKEN

data/lib/botup/config/Gemfile

@@ -1,3 +1,4 @@
 source 'https://rubygems.org'
 
+gem 'dotenv'
 gem 'telegram-bot-ruby'

data/lib/botup/file_processor.rb

@@ -4,6 +4,8 @@ require 'ostruct'
 
 module Botup
   class FileProcessor
+    FILE_NAMES_TO_SKIP = ['.', '..', 'core_file.erb'].freeze
+
     attr_reader :base_name
 
     def initialize(base_name)
@@ -23,16 +25,15 @@ module Botup
     def prepare_files
       FileUtils.mkdir_p(output_main_folder)
       FileUtils.mkdir_p("#{output_folder}/bin/")
-      FileUtils.mkdir_p("#{output_folder}/config/")
-      FileUtils.cp("#{config_folder}/config.yml", "#{output_folder}/config")
       FileUtils.cp("#{config_folder}/Gemfile", output_folder)
+      FileUtils.cp("#{config_folder}/.env", output_folder)
     end
 
     def populate_basic_templates(from, to)
       Dir.foreach(from) do |file_name|
         current_path =  "#{from}/#{file_name}"
 
-        next if file_name == '.' || file_name == '..' || file_name == 'core_file.erb'
+        next if FILE_NAMES_TO_SKIP.include?(file_name)
 
         erb = ERB.new(File.read(current_path))
         result = erb.result(namespace.instance_eval { binding })
@@ -43,10 +44,10 @@ module Botup
       end
     end
 
-    def populate_bot_named_files(source, out)
+    def populate_bot_named_files(source, output)
       erb = ERB.new(File.read(source))
       result = erb.result(namespace.instance_eval { binding })
-      File.open("#{out}", 'w') << result
+      File.open(output.to_s, 'w') << result
     end
 
     def bin_folder

data/lib/botup/templates/client.erb

@@ -1,7 +1,5 @@
 module <%= class_name %>
   class Client
-    attr_reader :token
-
     def initialize(token)
       @token = token
     end
@@ -18,22 +16,16 @@ module <%= class_name %>
 
     private
 
-    def run_client(&block)
-      Telegram::Bot::Client.run(token) do |bot|
-        yield bot if block_given?
-      end
-    end
+    attr_reader :token
 
     def respond
-      run_client do |bot|
+      Telegram::Bot::Client.run(token) do |bot|
         bot.listen do |message|
-          Responder.new(bot.api, message).call if message.text
+          next unless message.text
+
+          Responder.new(api: bot.api, message: message).call
         end
       end
     end
-
-    def get_updates(bot, next_offset)
-      bot.api.getUpdates(offset: next_offset, timeout: 20)
-    end
   end
 end

data/lib/botup/templates/commands_keeper.erb

@@ -1,19 +1,11 @@
 module <%= class_name %>
   module CommandsKeeper
-    COMMANDS = %i(test)
-
-    def test
+    def test(params:, message:)
       'Wow, I\'m using telegram bot!'
     end
 
-    def help
-      # Put some help info here
-    end
-
-    private
-
-    def has_command?(command)
-      COMMANDS.include?(command)
+    def help(**)
+      "Put some help information here"
     end
   end
 end

data/lib/botup/templates/commands_manager.erb

@@ -1,31 +1,18 @@
 module <%= class_name %>
   class CommandsManager
     include CommandsKeeper
+    extend Forwardable
 
-    attr_reader :command, :params, :message
+    def_delegators :@parser, :message, :command, :params
+    attr_reader :parser
 
-    def initialize(args)
-      @message = args.fetch(:message)
-      @command = detect_command
-      @params = parser.params
-    end
-
-    def call
-      if self.class.instance_method(command).arity == 0
-        send command
-      else
-        send command, params
-      end
-    end
-
-    private
 
-    def detect_command
-      has_command?(parser.command) ? parser.command : :help
+    def initialize(parser:)
+      @parser = parser
     end
 
-    def parser
-      MessageParser.new(message)
+    def call
+      send(command, params: params, message: message)
     end
   end
 end

data/lib/botup/templates/core_file.erb

@@ -1,18 +1,16 @@
+require 'dotenv/load'
 require 'telegram/bot'
-require 'yaml'
 
-$:.unshift("#{Dir.pwd}/lib")
+$LOAD_PATH.unshift("#{Dir.pwd}/lib")
 
-require '<%= snake_case_name %>/configurator'
 require '<%= snake_case_name %>/client'
-require '<%= snake_case_name %>/messenger'
 require '<%= snake_case_name %>/message_parser'
 require '<%= snake_case_name %>/commands_keeper'
 require '<%= snake_case_name %>/commands_manager'
 require '<%= snake_case_name %>/responder'
 
 module <%= class_name %>
-def self.start_client
-  Client.new(Configurator.bot_token).start
-end
+  def self.start
+    Client.new(ENV['TELEGRAM_BOT_TOKEN']).start
+  end
 end

data/lib/botup/templates/message_parser.erb

@@ -1,33 +1,40 @@
 module <%= class_name %>
   class MessageParser
-    attr_reader :message
+    DEFAULT_COMMAND = :help.freeze
+    COMMANDS = %i[test].freeze
 
-    def initialize(message)
+    attr_reader :message, :commands
+
+    def initialize(message:)
       @message = message
     end
 
     def command
-      parse_message.first.to_sym
+      COMMANDS.find { |command| command == parsed_message&.first&.to_sym } || DEFAULT_COMMAND
     end
 
     def params
-      parse_message { |words| words.drop(1) } || []
+      parsed_message&.drop(1) || []
     end
 
     private
 
-    def parse_message
-      if  message_present? && message_starts_with_slash?
-        message.text[1..-1].split(' ')
-      end
+    def can_parse?
+      message_present? && message_starts_with_slash?
     end
 
     def message_present?
-      message.text && message.text.length > 1
+      message.text&.length&.positive?
     end
 
     def message_starts_with_slash?
-      message.text[0] == '/'
+      message.text.start_with?("/")
+    end
+
+    def parsed_message
+      return unless can_parse?
+
+      message.text[1..-1].split(" ")
     end
   end
 end

data/lib/botup/templates/responder.erb

@@ -1,23 +1,18 @@
 module <%= class_name %>
   class Responder
-    attr_reader :api, :message
+    attr_reader :api, :message, :response
+    private :api, :message, :response
 
-    def initialize(api, message)
-      @api, @message = api, message
-    end
-
-    def call
-      messenger.send_text(parsed_response)
-    end
-
-    private
+    def initialize(api:, message:)
+      @api = api
+      @message = message
 
-    def messenger
-      @messenger ||= Messenger.new(api: api, chat_id: message.chat.id)
+      parser = MessageParser.new(message: message)
+      @response = CommandsManager.new(parser: parser).call
     end
 
-    def parsed_response
-      @parsed_response ||= CommandsManager.new(message: message, messenger: messenger).call
+    def call
+      api.send_message(chat_id: message.chat.id, text: response)
     end
   end
 end

data/lib/botup/version.rb

@@ -1,3 +1,3 @@
 module Botup
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: botup
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Emil Shakirov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-13 00:00:00.000000000 Z
+date: 2017-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.16'
 description: Command-line tool for generating boilerplate for telegram bot.
 email:
 - 5o.smoker@gmail.com
@@ -43,16 +43,14 @@ files:
 - botup.gemspec
 - lib/botup.rb
 - lib/botup/bin/exec.erb
+- lib/botup/config/.env
 - lib/botup/config/Gemfile
-- lib/botup/config/config.yml
 - lib/botup/file_processor.rb
 - lib/botup/templates/client.erb
 - lib/botup/templates/commands_keeper.erb
 - lib/botup/templates/commands_manager.erb
-- lib/botup/templates/configurator.erb
 - lib/botup/templates/core_file.erb
 - lib/botup/templates/message_parser.erb
-- lib/botup/templates/messenger.erb
 - lib/botup/templates/responder.erb
 - lib/botup/version.rb
 homepage: https://github.com/vaihtovirta/botup
@@ -75,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Telegram bot boilerplate generator

data/lib/botup/config/config.yml

@@ -1 +0,0 @@
-bot_token: <%= ENV['YOUR_TELEGRAM_TOKEN'] %>

data/lib/botup/templates/configurator.erb

@@ -1,23 +0,0 @@
-module <%= class_name %>
-  module Configurator
-    CONFIG_PATH = 'config/config.yml'.freeze
-
-    module_function
-
-    def bot_token
-      loaded['bot_token']
-    end
-
-    def loaded
-      YAML.load(erb_result)
-    end
-
-    def yaml_file
-      File.read(CONFIG_PATH)
-    end
-
-    def erb_result
-      ERB.new(yaml_file).result
-    end
-  end
-end

data/lib/botup/templates/messenger.erb

@@ -1,14 +0,0 @@
-module <%= class_name %>
-  class Messenger
-    attr_reader :api, :chat_id
-
-    def initialize(args)
-      @api = args.fetch(:api)
-      @chat_id = args.fetch(:chat_id)
-    end
-
-    def send_text(text)
-      api.send_message(chat_id: chat_id, text: text)
-    end
-  end
-end