telegrator 0.2.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: daec854c804de3d68236c33d1f620c7776beb2ba
+  data.tar.gz: a07185d871bb2d6170a62943dced3da72759e88c
+SHA512:
+  metadata.gz: 965bbccc435df7898b449f8b42714b30329c5d4d2e32dd4bc5453556d2e45a12ae8f6d923f05ae88349b08f7b4485e43012c04e16b313d1691d9735090cde96a
+  data.tar.gz: 6d8d4059a44ab658be59a8ab08b8c56da41ed16daeb10d9c44d76f9790cfb94925ec63e7acf03b53505dffa850d5a491d6fb54a1ff7cb201461e1f6efcd48599

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Aleksey Ivanov
+
+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,67 @@
+# Telegrator
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/telegrator`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'telegrator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install telegrator
+
+## Usage
+
+You can easily set up a new bot project:
+
+    $ telegrator new foo_bot
+
+This will generate a skeleton structure like this:
+```
+foo_bot/
+|__ app/
+    |__ commands/
+    |__ keyboards/
+    |__ models/
+    |__ workers/
+    |__ commands.rb
+    |__ keyboards.rb
+    |__ models.rb
+    |__ workers.rb
+|__ bin/
+    |__ bot
+|__ config/
+    |__ boot.rb
+    |__ initializers/
+        |__ ...
+|__ log/
+    |__ .keep
+|__ Gemfile
+|__ Rakefile
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/telegrator.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "telegrator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/telegrator

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'telegrator'
+require 'telegrator/cli'
+
+Telegrator::CLI.start

data/lib/telegrator/cli.rb

@@ -0,0 +1,8 @@
+require 'thor'
+
+module Telegrator
+  class CLI < Thor
+    # register(class_name, subcommand_alias, usage_list_string, description_string)
+    register(Generators::Bot, 'bot', 'bot', 'Generate a skeleton for creating a new bot')
+  end
+end

data/lib/telegrator/generators/base.rb

@@ -0,0 +1,15 @@
+module Telegrator
+  module Generators
+    class Base < Thor::Group
+      class << self
+        def dispatch(command, given_args, given_opts, config)
+          if command.nil? && given_args.empty? && given_opts.empty?
+            given_args << '--help'
+            given_opts << '--help'
+          end
+          super
+        end
+      end
+    end
+  end
+end

data/lib/telegrator/generators/bot/generator.rb

@@ -0,0 +1,104 @@
+module Telegrator
+  module Generators
+    class Bot < Base
+      include Thor::Actions
+
+      DATABASES = %w[postgresql mongodb]
+
+      # TODO: move to Base class
+      def self.source_root
+        File.expand_path('../templates', __FILE__)
+      end
+
+      def initialize(args = [], options = {}, config = {})
+        config[:destination_root] ||= args.first
+        super
+      end
+
+      class_option :database, type: :string, aliases: '-d', default: 'postgresql', enum: DATABASES,
+                              desc: 'Preconfigure for selected database'
+
+      class_option :skip_capistrano, type: :boolean, default: false,
+                                     desc: 'Skip Capistrano'
+
+      class_option :skip_keyboards, type: :boolean, default: false,
+                                    desc: 'Skip keyboards'
+
+      class_option :skip_webhook, type: :boolean, default: false,
+                                  desc: 'Skip webhook'
+
+      class_option :help, type: :boolean, aliases: '-h',
+                          desc: 'Show this help message and quit'
+
+      namespace 'bot'
+      desc 'Bot generator description'
+
+      argument :name
+
+      # === app/ directory ===
+      def create_app_dir
+        empty_directory 'app'
+      end
+
+      def create_commands
+        template 'app/commands.rb'
+        directory 'app/commands'
+      end
+
+      # TODO: inline keyboards
+
+      def create_keyboards
+        return if options[:skip_keyboards]
+        template 'app/keyboards.rb'
+        directory 'app/keyboards'
+      end
+
+      def create_models
+        template 'app/models.rb'
+        directory 'app/models'
+      end
+
+      def create_workers
+        template 'app/workers.rb'
+        directory 'app/workers'
+      end
+
+      # === bin/ directory ===
+      def create_bin_dir
+        directory 'bin'
+      end
+
+      # === config/ directory ===
+      def create_config_dir
+        directory 'config'
+      end
+
+      # === lib/ directory ===
+      def create_lib_dir
+        empty_directory 'lib/tasks'
+      end
+
+      # === log/ directory ===
+      def create_log_dir
+        empty_directory 'log'
+        create_file 'log/.keep'
+      end
+
+      def create_gemfile
+        template 'Gemfile.tt'
+      end
+
+      def create_rakefile
+        template 'Rakefile.tt'
+      end
+
+      private
+
+      DATABASES.each do |db|
+        define_method "#{db}?" do
+          options[:database] == db
+        end
+      end
+    end
+  end
+end

data/lib/telegrator/generators/bot/templates/Gemfile.tt

@@ -0,0 +1,31 @@
+source 'https://rubygems.org'
+
+gem 'dotenv'
+gem 'rake'
+gem 'sidekiq'
+gem 'telegram-bot-ruby'
+
+<%- if postgresql? -%>
+gem 'pg'
+gem 'sequel'
+<%- elsif mongodb? -%>
+gem 'mongoid'
+<%- end -%>
+
+<%- unless options.skip_webhook? -%>
+gem 'puma'
+gem 'rack-contrib'
+<%- end -%>
+
+<%- unless options.skip_capistrano? -%>
+group :development do
+  gem 'capistrano'
+  gem 'capistrano-bundler'
+  gem 'capistrano-rbenv'
+  gem 'capistrano-sidekiq'
+
+  <%- unless options.skip_webhook? -%>
+  gem 'capistrano3-puma'
+  <%- end -%>
+end
+<%- end -%>

data/lib/telegrator/generators/bot/templates/Rakefile.tt

@@ -0,0 +1 @@
+Rake.add_rakelib('lib/tasks')

data/lib/telegrator/generators/bot/templates/app/commands/base.rb.tt

@@ -0,0 +1,26 @@
+module Commands
+  class Base
+    def self.invoke(*args)
+      new(*args).invoke
+    end
+
+    def initialize(message, user)
+      @message = message
+      @user = user
+    end
+
+    def invoke
+      raise NotImplementedError
+    end
+
+    private
+
+    def say(text)
+      send_message(@user.telegram_id, text)
+    end
+
+    def send_message(chat_id, text)
+      BOT.api.send_message(chat_id: chat_id, text: text, parse_mode: 'Markdown')
+    end
+  end
+end

data/lib/telegrator/generators/bot/templates/app/commands/missing.rb.tt

@@ -0,0 +1,7 @@
+module Commands
+  class Missing < Base
+    def invoke
+      say 'Неизвестная команда.'
+    end
+  end
+end

data/lib/telegrator/generators/bot/templates/app/commands/start.rb.tt

@@ -0,0 +1,7 @@
+module Commands
+  class Start < Base
+    def invoke
+      say 'Добро пожаловать.'
+    end
+  end
+end

data/lib/telegrator/generators/bot/templates/app/commands/stop.rb.tt

@@ -0,0 +1,7 @@
+module Commands
+  class Stop < Base
+    def invoke
+      say 'До свидания.'
+    end
+  end
+end

data/lib/telegrator/generators/bot/templates/app/commands.rb.tt

@@ -0,0 +1,6 @@
+module Commands
+  autoload :Base,    'commands/base'
+  autoload :Start,   'commands/start'
+  autoload :Stop,    'commands/stop'
+  autoload :Missing, 'commands/missing'
+end

data/lib/telegrator/generators/bot/templates/app/keyboards/base.rb.tt

@@ -0,0 +1,28 @@
+module Keyboards
+  class Base
+    attr_reader :keyboard, :user
+
+    def self.show(*args)
+      new(*args).show
+    end
+
+    def initialize(user)
+      @keyboard = define_keyboard
+      @user = user
+    end
+
+    def show
+      BOT.api.send_message(chat_id: user.telegram_id, text: text, reply_markup: keyboard)
+    end
+
+    private
+
+    def define_keyboard
+      raise NotImplementedError
+    end
+
+    def text
+      raise NotImplementedError
+    end
+  end
+end

data/lib/telegrator/generators/bot/templates/app/keyboards.rb.tt

@@ -0,0 +1,3 @@
+module Keyboards
+  autoload :Base, 'keyboards/base'
+end

data/lib/telegrator/generators/bot/templates/app/models/base.rb.tt

@@ -0,0 +1,5 @@
+module Models
+  class Base < Sequel::Model
+    plugin :timestamps
+  end
+end

data/lib/telegrator/generators/bot/templates/app/models/user.rb.tt

@@ -0,0 +1,5 @@
+module Models
+  class User < Base
+    set_dataset :users
+  end
+end

data/lib/telegrator/generators/bot/templates/app/models.rb.tt

@@ -0,0 +1,4 @@
+module Models
+  autoload :Base, 'models/base'
+  autoload :User, 'models/user'
+end

data/lib/telegrator/generators/bot/templates/app/workers/base.rb.tt

@@ -0,0 +1,6 @@
+module Workers
+  class Base
+    include Sidekiq::Worker
+    sidekiq_options retry: false
+  end
+end

data/lib/telegrator/generators/bot/templates/app/workers/processor.rb.tt

@@ -0,0 +1,41 @@
+module Workers
+  class Processor < Base
+    HANDLERS = {
+      '\A\/start(\s.*|\z)' => Commands::Start,
+      '\A\/stop\z'         => Commands::Stop
+    }.freeze
+
+    def perform(message_dump)
+      process_message YAML.load(message_dump)
+    end
+
+    private
+
+    def process_message(message)
+      user = user_by_message(message)
+      command_klass(message).invoke(message, user)
+    end
+
+    def user_by_message(message)
+      from = message.from
+      user = Models::User.find_or_initialize_by(telegram_id: from.id)
+      if user.new_record?
+        user.update(first_name: from.first_name, last_name: from.last_name, username: from.username)
+      end
+      user
+    end
+
+    def command_klass(message)
+      command_klass_by_text(message.text) || Commands::Missing
+    end
+
+    def command_klass_by_text(text)
+      key = HANDLERS.keys.find { |regex| /#{regex}/ =~ prepare_text(text) }
+      HANDLERS[key]
+    end
+
+    def prepare_text(text)
+      text.strip
+    end
+  end
+end

data/lib/telegrator/generators/bot/templates/app/workers.rb.tt

@@ -0,0 +1,4 @@
+module Workers
+  autoload :Base,      'workers/base'
+  autoload :Processor, 'workers/processor'
+end

data/lib/telegrator/generators/bot/templates/bin/bot.tt

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require File.expand_path('../../config/boot', __FILE__)
+
+BOT.run do |bot|
+  bot.listen do |message|
+    Workers::Processor.perform_async YAML.dump(message)
+  end
+end

data/lib/telegrator/generators/bot/templates/config/boot.rb.tt

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+
+Dir.glob(File.expand_path('../../config/initializers/*.rb', __FILE__)).sort.each do |f|
+  require f
+end
+
+$LOAD_PATH.unshift ROOT.join('app').to_s
+
+require 'commands'
+<%- unless options.skip_keyboards? -%>
+require 'keyboards'
+<%- end -%>
+require 'models'
+require 'workers'

data/lib/telegrator/generators/bot/templates/config/initializers/01_env.rb.tt

@@ -0,0 +1,3 @@
+require 'dotenv'
+
+Dotenv.load

data/lib/telegrator/generators/bot/templates/config/initializers/02_root.rb.tt

@@ -0,0 +1 @@
+ROOT = Pathname.new(File.expand_path('../../../', __FILE__))

data/lib/telegrator/generators/bot/templates/config/initializers/bot.rb.tt

@@ -0,0 +1,3 @@
+require 'telegram/bot'
+
+BOT = Telegram::Bot::Client.new(ENV['BOT_TOKEN'], logger: Logger.new('log/bot.log'))

data/lib/telegrator/generators.rb

@@ -0,0 +1,6 @@
+module Telegrator
+  module Generators
+    autoload :Base, 'telegrator/generators/base'
+    autoload :Bot,  'telegrator/generators/bot/generator'
+  end
+end

data/lib/telegrator/version.rb

@@ -0,0 +1,3 @@
+module Telegrator
+  VERSION = '0.2.0.rc1'
+end

data/lib/telegrator.rb

@@ -0,0 +1,5 @@
+require 'telegrator/generators'
+require 'telegrator/version'
+
+module Telegrator
+end

data/telegrator.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'telegrator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'telegrator'
+  spec.version       = Telegrator::VERSION
+  spec.authors       = ['Aleksey Ivanov']
+  spec.email         = ['ialexxei@gmail.com']
+
+  spec.summary       = 'A generator to set up new Telegram bot easily'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/ivanovaleksey/telegrator'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'thor', '~> 0.19.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: telegrator
+version: !ruby/object:Gem::Version
+  version: 0.2.0.rc1
+platform: ruby
+authors:
+- Aleksey Ivanov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A generator to set up new Telegram bot easily
+email:
+- ialexxei@gmail.com
+executables:
+- telegrator
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/telegrator
+- lib/telegrator.rb
+- lib/telegrator/cli.rb
+- lib/telegrator/generators.rb
+- lib/telegrator/generators/base.rb
+- lib/telegrator/generators/bot/generator.rb
+- lib/telegrator/generators/bot/templates/Gemfile.tt
+- lib/telegrator/generators/bot/templates/Rakefile.tt
+- lib/telegrator/generators/bot/templates/app/commands.rb.tt
+- lib/telegrator/generators/bot/templates/app/commands/base.rb.tt
+- lib/telegrator/generators/bot/templates/app/commands/missing.rb.tt
+- lib/telegrator/generators/bot/templates/app/commands/start.rb.tt
+- lib/telegrator/generators/bot/templates/app/commands/stop.rb.tt
+- lib/telegrator/generators/bot/templates/app/keyboards.rb.tt
+- lib/telegrator/generators/bot/templates/app/keyboards/base.rb.tt
+- lib/telegrator/generators/bot/templates/app/models.rb.tt
+- lib/telegrator/generators/bot/templates/app/models/base.rb.tt
+- lib/telegrator/generators/bot/templates/app/models/user.rb.tt
+- lib/telegrator/generators/bot/templates/app/workers.rb.tt
+- lib/telegrator/generators/bot/templates/app/workers/base.rb.tt
+- lib/telegrator/generators/bot/templates/app/workers/processor.rb.tt
+- lib/telegrator/generators/bot/templates/bin/bot.tt
+- lib/telegrator/generators/bot/templates/config/boot.rb.tt
+- lib/telegrator/generators/bot/templates/config/initializers/01_env.rb.tt
+- lib/telegrator/generators/bot/templates/config/initializers/02_root.rb.tt
+- lib/telegrator/generators/bot/templates/config/initializers/bot.rb.tt
+- lib/telegrator/version.rb
+- telegrator.gemspec
+homepage: https://github.com/ivanovaleksey/telegrator
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A generator to set up new Telegram bot easily
+test_files: []