botup 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ff5e5ebf1b3fe664afda09447d2d6222a040f7c
+  data.tar.gz: 2dfd7eead22e9ff7ca90b4ce105fd5b04e5d599d
+SHA512:
+  metadata.gz: 3647400ec02cd3ff27779ac5919533fceed072b7eab9f4bcc3ed82ecbfa9b0162f587d4d4dcfa849b782d6c633fd03b46152c5f82d9fa829c3e31435018dffc5
+  data.tar.gz: 48b0c2aef0eef38712903aa2c5a911e023f189d70d6700c038d268c42f368180eca98c620a67000b929747149806d5db4435bfed39e5f14ee7e9bef94718b8dc

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea

data/.rubocop.yml

@@ -0,0 +1,24 @@
+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
+
+Metrics/LineLength:
+  Max: 110
+
+Style/SymbolArray:
+  Enabled: true
+
+Metrics/AbcSize:
+  Exclude:
+    - 'test/**/*'

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,50 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at [INSERT EMAIL ADDRESS]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in botup.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Emil Shakirov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# Botup
+
+**Botup** is command-line tool that generates basic skeleton for telegram bot.
+
+## Installation
+
+Just run this in your terminal:
+
+    $ gem install botup
+
+## Usage
+
+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 
+    |____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
+    | | |____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**
+- 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 
+    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)
+
+    ![](https://monosnap.com/file/c2WA7eWNmsex9ccf9E50C36Vro17kr.png)
+- Sit back and take a glass of Pina Colada!
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vaihtovirta/botup. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Credits
+
+Originally was inspired(and partially borrowed) by [telegram_meetup_bot](https://github.com/mendab1e/telegram_meetup_bot).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/bin/botup

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'botup'
+
+Botup::Generator.generate(ARGV.first)

data/botup.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'botup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'botup'
+  spec.version       = Botup::VERSION
+  spec.authors       = ['Emil Shakirov']
+  spec.email         = ['5o.smoker@gmail.com']
+
+  spec.summary       = 'Telegram bot boilerplate generator'
+  spec.description   = 'Command-line tool for generating boilerplate for telegram bot.'
+  spec.homepage      = 'https://github.com/vaihtovirta/botup'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+end

data/lib/botup.rb

@@ -0,0 +1,10 @@
+require 'botup/version'
+require 'botup/file_processor'
+
+module Botup
+  class Generator
+    def self.generate(name)
+      FileProcessor.new(name).call
+    end
+  end
+end

data/lib/botup/bin/exec.erb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '<%= "../lib/#{snake_case_name}" %>'
+
+<%= class_name %>.start_client

data/lib/botup/config/Gemfile

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

data/lib/botup/config/config.yml

@@ -0,0 +1 @@
+bot_token: 'YOUR_TOKEN_GOES_HERE'

data/lib/botup/file_processor.rb

@@ -0,0 +1,93 @@
+require 'fileutils'
+require 'erb'
+require 'ostruct'
+
+module Botup
+  class FileProcessor
+    attr_reader :base_name
+
+    def initialize(base_name)
+      @base_name = base_name
+    end
+
+    def call
+      prepare_files
+      populate_basic_templates(templates_folder, output_main_folder)
+      populate_bot_named_files("#{templates_folder}/core_file.erb", "#{output_lib_folder}/#{base_name}.rb")
+      populate_bot_named_files("#{bin_folder}/exec.erb", "#{output_folder}/bin/#{base_name}")
+      FileUtils.chmod('+x', "#{output_folder}/bin/#{base_name}")
+    end
+
+    private
+
+    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)
+    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'
+
+        erb = ERB.new(File.read(current_path))
+        result = erb.result(namespace.instance_eval { binding })
+
+        ruby_file_path = "#{to}/#{File.basename(file_name, '.erb')}.rb"
+
+        File.open(ruby_file_path, 'w') << result
+      end
+    end
+
+    def populate_bot_named_files(source, out)
+      erb = ERB.new(File.read(source))
+      result = erb.result(namespace.instance_eval { binding })
+      File.open("#{out}", 'w') << result
+    end
+
+    def bin_folder
+      "#{__dir__}/bin"
+    end
+
+    def config_folder
+      "#{__dir__}/config"
+    end
+
+    def templates_folder
+      "#{__dir__}/templates"
+    end
+
+    def core_file
+      "#{templates_folder}/bot.erb"
+    end
+
+    def output_lib_folder
+      "#{output_folder}/lib/"
+    end
+
+    def output_folder
+      "#{current_dir}/#{base_name}"
+    end
+
+    def output_main_folder
+      "#{output_folder}/lib/#{base_name}"
+    end
+
+    def current_dir
+      Dir.pwd
+    end
+
+    def namespace
+      OpenStruct.new(class_name: class_name,
+                     snake_case_name: base_name)
+    end
+
+    def class_name
+      base_name.split('_').collect(&:capitalize).join
+    end
+  end
+end

data/lib/botup/templates/client.erb

@@ -0,0 +1,27 @@
+module <%= class_name %>
+  class Client
+    attr_reader :token
+
+    def initialize(token)
+      @token = token
+    end
+
+    def start
+      begin
+        Telegram::Bot::Client.run(token) do |bot|
+          bot.listen do |message|
+            if message.text
+              messenger = Messenger.new(api: bot.api, chat_id: message.chat.id)
+              response = CommandsManager.new(message: message, messenger: messenger).call
+              messenger.send_text(response)
+            end
+          end
+        end
+      rescue Telegram::Bot::Exceptions::ResponseError => e
+        puts e
+        sleep 1
+        retry # run again on telegram server error
+      end
+    end
+  end
+end

data/lib/botup/templates/commands_keeper.erb

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

data/lib/botup/templates/commands_manager.erb

@@ -0,0 +1,33 @@
+require_relative 'commands_keeper'
+
+module <%= class_name %>
+  class CommandsManager
+    include CommandsKeeper
+
+    attr_reader :command, :params, :message
+
+    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
+    end
+
+    def parser
+      MessageParser.new(message)
+    end
+  end
+end

data/lib/botup/templates/core_file.erb

@@ -0,0 +1,18 @@
+require 'telegram/bot'
+require 'yaml'
+
+$:.unshift("#{Dir.pwd}/lib")
+
+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'
+
+module <%= class_name %>
+  CONFIGURATION = YAML.load_file("#{Dir.pwd}/config/config.yml")
+
+  def self.start_client
+    Client.new(CONFIGURATION['bot_token']).start
+  end
+end

data/lib/botup/templates/message_parser.erb

@@ -0,0 +1,25 @@
+module <%= class_name %>
+  class MessageParser
+    attr_reader :message
+
+    def initialize(message)
+      @message = message
+    end
+
+    def command
+      parse_message.first.to_sym
+    end
+
+    def params
+      parse_message { |words| words.drop(1) } || []
+    end
+
+    private
+
+    def parse_message
+      if message.text && message.text[0] == '/' && message.text.length > 1
+        message.text[1..-1].split(' ')
+      end
+    end
+  end
+end

data/lib/botup/templates/messenger.erb

@@ -0,0 +1,14 @@
+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

data/lib/botup/version.rb

@@ -0,0 +1,3 @@
+module Botup
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: botup
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Emil Shakirov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: Command-line tool for generating boilerplate for telegram bot.
+email:
+- 5o.smoker@gmail.com
+executables:
+- botup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- bin/botup
+- botup.gemspec
+- lib/botup.rb
+- lib/botup/bin/exec.erb
+- 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/core_file.erb
+- lib/botup/templates/message_parser.erb
+- lib/botup/templates/messenger.erb
+- lib/botup/version.rb
+homepage: https://github.com/vaihtovirta/botup
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Telegram bot boilerplate generator
+test_files: []
+has_rdoc: