barrymore 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46a6ce64d4da08b2adc438ab6f02ca73b918f7ee
+  data.tar.gz: 6295c842ad2bbd6a21cbab24a41db5ee0b2b796b
+SHA512:
+  metadata.gz: 52e11fc0c07b69ca085414e3dd4899244a6e4fe896d547faaf126375bb8a561bcbe5cc88cc357b7ceb0894cf8c79decd318bc6cb666b6fe5ef50280907eeeafe
+  data.tar.gz: 1284d90ec8fd22372fd147a798f03e30ea8b3ee4be4e73aa539bde208a5d39f7e4d3e334a3c16792ffff4a8a0abfb5f63685c146556fe099a319094a5a41ed41

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dmitriy Non
+
+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,108 @@
+# Barrymore
+
+Barrymore - is a DSL for defining chat bot commands (like telegram bot
+commands).
+To create telegram bot you will need to use bot api gem (like `telegram-bot-ruby`).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'barrymore'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install barrymore
+
+## Usage
+
+This is an example of usage Barrymore for telegram bot (using gem [`telegram-bot-ruby`](https://github.com/atipugin/telegram-bot-ruby).
+But Barrymore can be used for whatever chats you want.
+For example, [specs](spec/barrymore_spec.rb)  are written without any
+chat at all.
+
+
+```ruby
+require 'telegram/bot'
+require 'barrymore'
+
+class MyBot < Telegram::Bot::Client
+  include Barrymore
+
+  #
+  # /start
+  #
+
+  define_command('/start') do |msg|
+    if chat_data(msg)[:started_at]
+      api.send_message(chat_id: msg.chat, text: 'We met already')
+    else
+      set_chat_data(msg, started_at: Time.now)
+      api.send_message(chat_id: msg.chat, text: "Hello, #{msg.data[:name]}!")
+    end
+  end
+
+  #
+  # /google
+  #
+
+  define_command('/google') do |msg|
+    start_command_processing(msg)
+    api.send_message(chat_id: msg.chat, text: 'What do you want to google?')
+  end
+
+  define_command_continuation('/google') do |msg|
+    stop_command_processing(msg)
+    api.send_message(chat_id: msg.chat, text: "http://lmgtfy.com/?q=#{URI.escape msg.text}")
+  end
+
+  # msg [Barrymore::Message]
+  def process_message(msg)
+    if command_in_progress?(msg)
+      continue_command(msg)
+    elsif command_defined?(msg)
+      execute_command(msg)
+    else
+      api.send_message(chat_id: msg.chat, text: 'wrong command!')
+    end
+  end
+
+  # converts telegram message to barrymore message
+  def berrymore_message(telegram_message)
+    Message.new text: telegram_message.text,
+                chat: telegram_message.chat.id,
+                data: { name: telegram_message.from.first_name }
+  end
+end
+
+token = raise 'REPLACE IT WITH YOUR TOKEN'
+
+MyBot.run(token) do |bot|
+  bot.listen do |telegram_message|
+    barrymore_msg = bot.berrymore_message(telegram_message)
+    bot.process_message(barrymore_msg)
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/Nondv/barrymore.
+
+
+## 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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/barrymore.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'barrymore/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'barrymore'
+  spec.version       = Barrymore::VERSION
+  spec.authors       = ['Dmitriy Non']
+  spec.email         = ['non.dmitriy@gmail.com']
+
+  spec.summary       = 'Barrymore - DSL for defining chat bot commands (like telegram bot commands)'
+  spec.homepage      = 'https://github.com/Nondv/barrymore'
+  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_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '0.46.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'barrymore'
+
+# 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

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/lib/barrymore.rb

@@ -0,0 +1,30 @@
+require 'barrymore/version'
+require 'barrymore/message'
+require 'barrymore/class_methods'
+require 'barrymore/instance_methods'
+
+#
+# Barrymore is a DSL for defining chat bots commands.
+# Especially useful for Telegram bots.
+#
+module Barrymore
+  class UndefinedCommandError < StandardError; end
+  class NoCommandInProgressError < StandardError; end
+
+  # It is used for storing commands. You don't need it
+  class BotCommand
+    attr_reader :name, :execution
+    attr_accessor :continuation
+
+    def initialize(name, &block)
+      raise(ArgumentError, 'no block given') unless block
+      @name = name.freeze
+      @execution = block
+    end
+  end
+
+  def self.included(klass)
+    klass.include InstanceMethods
+    klass.extend ClassMethods
+  end
+end

data/lib/barrymore/class_methods.rb

@@ -0,0 +1,40 @@
+module Barrymore
+  #
+  # Class-level DSL
+  #
+  module ClassMethods
+    def define_command(name, &block)
+      raise(ArgumentError, 'no block given') unless block
+      barrymore_commands[name] = BotCommand.new(name, &block)
+    end
+
+    def define_command_continuation(name, &block)
+      raise(ArgumentError, 'no block given') unless block
+      raise(UndefinedCommandError, name) unless command_defined?(name)
+      get_barrymore_command(name).continuation = block
+    end
+
+    # arg [Message|String]
+    def command_defined?(arg)
+      name = arg.is_a?(String) ? arg : arg.text
+      barrymore_commands.key?(name)
+    end
+
+    #
+    # You don't need private methods.
+    # They are only for barrymore implementation
+    #
+
+    private
+
+    # arg [Message|String]
+    def get_barrymore_command(arg)
+      name = arg.is_a?(String) ? arg : arg.text
+      barrymore_commands[name]
+    end
+
+    def barrymore_commands
+      @barrymore_commands ||= {}
+    end
+  end
+end

data/lib/barrymore/instance_methods.rb

@@ -0,0 +1,71 @@
+module Barrymore
+  #
+  # Instance-level helpers
+  #
+  module InstanceMethods
+    # command should be specified in msg.text.
+    # chat should be specified in msg.chat.
+    def execute_command(msg)
+      raise(UndefinedCommandError, msg.text) unless command_defined?(msg)
+      instance_exec(msg, &get_barrymore_command(msg).execution)
+    end
+
+    def start_command_processing(msg)
+      # TODO: use chat_data ?
+      commands_in_progress[msg.chat] = msg.text
+    end
+
+    def stop_command_processing(msg)
+      commands_in_progress.delete(msg.chat)
+    end
+
+    # arg [Object] - arg.chat or arg itself will be used
+    def set_chat_data(arg, data)
+      chat = arg.respond_to?(:chat) ? arg.chat : arg
+      barrymore_chats_data[chat] = chat_data(arg).merge(data).freeze
+    end
+
+    # arg [Object] - arg.chat or arg itself will be used
+    def chat_data(arg)
+      chat = arg.respond_to?(:chat) ? arg.chat : arg
+      barrymore_chats_data[chat] ||= {}.freeze
+    end
+
+    def continue_command(msg)
+      raise(NoCommandInProgressError, msg.chat.to_s) unless command_in_progress?(msg)
+      proc = get_barrymore_command(commands_in_progress[msg.chat]).continuation
+      instance_exec(msg, &proc)
+    end
+
+    def command_defined?(*args)
+      self.class.command_defined?(*args)
+    end
+
+    def command_in_progress?(msg)
+      commands_in_progress.key?(msg.chat)
+    end
+
+    def commands_in_progress
+      @commands_in_progress ||= {}
+    end
+
+    #
+    # You don't need private methods.
+    # They are only for barrymore implementation
+    #
+
+    private
+
+    def barrymore_chats_data
+      @barrymore_chats_data ||= {}
+    end
+
+    def barrymore_commands
+      self.class.send :barrymore_commands
+    end
+
+    def get_barrymore_command(*args)
+      self.class.send(:get_barrymore_command, *args)
+    end
+  end
+end

data/lib/barrymore/message.rb

@@ -0,0 +1,17 @@
+module Barrymore
+  # Barrymore implementation of message.
+  # You could use it or provide yours with the same behavior
+  class Message
+    attr_reader :chat, :text, :data
+
+    def initialize(chat:, text:, data: nil)
+      self.chat = chat.freeze
+      self.text = text.freeze
+      self.data = data.freeze if data
+    end
+
+    private
+
+    attr_writer :chat, :text, :data
+  end
+end

data/lib/barrymore/version.rb

@@ -0,0 +1,3 @@
+module Barrymore
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: barrymore
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmitriy Non
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+description: 
+email:
+- non.dmitriy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- barrymore.gemspec
+- bin/console
+- bin/setup
+- lib/barrymore.rb
+- lib/barrymore/class_methods.rb
+- lib/barrymore/instance_methods.rb
+- lib/barrymore/message.rb
+- lib/barrymore/version.rb
+homepage: https://github.com/Nondv/barrymore
+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.6.7
+signing_key: 
+specification_version: 4
+summary: Barrymore - DSL for defining chat bot commands (like telegram bot commands)
+test_files: []