bot_brain 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: e3588f6b0a485be4e37dbd19b80c85152662998f
4
+ data.tar.gz: e9b2e45808acb8d90a73a456f0138ad56bfc928d
5
+ SHA512:
6
+ metadata.gz: b67c465ce231e1e6143a13df9ce95d300f8002df493b5b0b4cd5dee58a0700c3773a399572598a6ad8060e76a5b26f545ca07b5b5175eb64ce2f729aa72f1389
7
+ data.tar.gz: b9039bf2f78ca5b1a199739306775b1babdeb5589fcba0a6be24cf5d6cbd42683d0b1731f158c58ae58cebdecb5e74f4bd7b534074c3888cd2f95b4d5752606b
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.1
5
+ before_install: gem install bundler -v 1.12.5
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at alexander.kalinichev@gmail.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in telegram_brain.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 blackchestnut
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,39 @@
1
+ # Bot Brain
2
+
3
+ Simple Ruby class library for Telegram's Bot API
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'bot_brain'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install bot_brain
20
+
21
+ ## Usage
22
+
23
+ TODO: Write usage instructions here
24
+
25
+ ## Development
26
+
27
+ 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.
28
+
29
+ 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).
30
+
31
+ ## Contributing
32
+
33
+ Bug reports and pull requests are welcome on GitHub at https://github.com/blackchestnut/bot_brain. 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.
34
+
35
+
36
+ ## License
37
+
38
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
39
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "bot_brain"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/bot_brain.gemspec ADDED
@@ -0,0 +1,25 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'bot_brain/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "bot_brain"
8
+ spec.version = BotBrain::VERSION
9
+ spec.authors = ["blackchestnut"]
10
+ spec.email = ["alexander.kalinichev@gmail.com"]
11
+
12
+ spec.summary = %q{Simple Ruby class library for Telegram's Bot API}
13
+ spec.homepage = "https://github.com/blackchestnut/bot_brain"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
17
+ spec.bindir = "exe"
18
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.12"
22
+ spec.add_development_dependency "rake", "~> 10.0"
23
+ spec.add_development_dependency "rspec", "~> 3.0"
24
+ spec.add_development_dependency "telegram-bot-ruby"
25
+ end
data/lib/bot_brain.rb ADDED
@@ -0,0 +1,41 @@
1
+ require 'telegram/bot'
2
+
3
+ require 'bot_brain/version'
4
+ require 'bot_brain/chat'
5
+ require 'bot_brain/dictionary'
6
+ require 'bot_brain/message'
7
+ require 'bot_brain/commands/command'
8
+ require 'bot_brain/commands/unknown_command'
9
+
10
+ module BotBrain
11
+ class Brain
12
+ def initialize(token, dictionary)
13
+ @token = token
14
+ @dictionary = dictionary
15
+ @chats = {}
16
+ end
17
+
18
+ def answer(raw_message)
19
+ message = BotBrain::Message.new(raw_message)
20
+ add_to_chat(message)
21
+ command = @dictionary.get_command(message)
22
+ text = command.answer(message)
23
+ api.call('sendMessage', chat_id: message.chat_id, text: text)
24
+ end
25
+
26
+ private
27
+
28
+ def add_to_chat(message)
29
+ chat = find_or_create_chat(message.chat_id)
30
+ chat.add(message)
31
+ end
32
+
33
+ def find_or_create_chat(chat_id)
34
+ @chats[chat_id] || @chats[chat_id] = BotBrain::Chat.new(chat_id)
35
+ end
36
+
37
+ def api
38
+ @api ||= ::Telegram::Bot::Api.new(@token)
39
+ end
40
+ end
41
+ end
@@ -0,0 +1,14 @@
1
+ module BotBrain
2
+ class Chat
3
+ attr_reader :id, :messages
4
+
5
+ def initialize(chat_id)
6
+ @id = chat_id
7
+ @messages = []
8
+ end
9
+
10
+ def add(message)
11
+ @messages << message
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,55 @@
1
+ module BotBrain
2
+ module Commands
3
+ class Command
4
+ attr_reader :name
5
+
6
+ def initialize(name)
7
+ @name = name
8
+ @alias = name
9
+ end
10
+
11
+ def can_answer?(message)
12
+ data = name_regexp.match(message.text)
13
+ !!data && data.length > 0
14
+ end
15
+
16
+ def answer(message)
17
+ @args = parse_args(message.text)
18
+ return help_full if @args == '?'
19
+
20
+ process(message)
21
+ end
22
+
23
+ def help
24
+ "#{name} - #{description}\n"
25
+ end
26
+
27
+ private
28
+
29
+ def process(message)
30
+ message.text
31
+ end
32
+
33
+ def description
34
+ 'No description, this is abstract command'
35
+ end
36
+
37
+ def example
38
+ 'No example, this is abstract command'
39
+ end
40
+
41
+ def help_full
42
+ "#{help}\nExample:\n#{example}"
43
+ end
44
+
45
+ def parse_args(text)
46
+ return if text.nil?
47
+ text.sub(name_regexp, '').strip
48
+ end
49
+
50
+ def name_regexp
51
+ @name_regexp ||= Regexp.new("\\A#{name}")
52
+ end
53
+ end
54
+ end
55
+ end
@@ -0,0 +1,21 @@
1
+ module BotBrain
2
+ module Commands
3
+ class UnknownCommand < Command
4
+ def initialize
5
+ super('')
6
+ end
7
+
8
+ private
9
+
10
+ def process(message)
11
+ "Unknown command: #{message.text}"
12
+ end
13
+
14
+ def description
15
+ end
16
+
17
+ def example
18
+ end
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,13 @@
1
+ module BotBrain
2
+ class Dictionary
3
+ def initialize(commands, unknown_command = nil)
4
+ @commands = commands
5
+ @unknown_command = unknown_command || Commands::UnknownCommand.new
6
+ end
7
+
8
+ def get_command(message)
9
+ command = @commands.detect { |c| c.can_answer?(message) }
10
+ command || @unknown_command
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,23 @@
1
+ module BotBrain
2
+ class Message
3
+ def initialize(data)
4
+ @data = data || {}
5
+ end
6
+
7
+ def chat_id
8
+ @data['chat'] && @data['chat']['id']
9
+ end
10
+
11
+ def text
12
+ @data['text']
13
+ end
14
+
15
+ def user_full_name
16
+ "#{@data['from']['first_name']} #{@data['from']['last_name']}"
17
+ end
18
+
19
+ def to_s
20
+ @data.to_s
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,3 @@
1
+ module BotBrain
2
+ VERSION = '0.0.1'
3
+ end
metadata ADDED
@@ -0,0 +1,118 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: bot_brain
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - blackchestnut
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-09-20 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.12'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.12'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: telegram-bot-ruby
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ description:
70
+ email:
71
+ - alexander.kalinichev@gmail.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".rspec"
78
+ - ".travis.yml"
79
+ - CODE_OF_CONDUCT.md
80
+ - Gemfile
81
+ - LICENSE.txt
82
+ - README.md
83
+ - Rakefile
84
+ - bin/console
85
+ - bin/setup
86
+ - bot_brain.gemspec
87
+ - lib/bot_brain.rb
88
+ - lib/bot_brain/chat.rb
89
+ - lib/bot_brain/commands/command.rb
90
+ - lib/bot_brain/commands/unknown_command.rb
91
+ - lib/bot_brain/dictionary.rb
92
+ - lib/bot_brain/message.rb
93
+ - lib/bot_brain/version.rb
94
+ homepage: https://github.com/blackchestnut/bot_brain
95
+ licenses:
96
+ - MIT
97
+ metadata: {}
98
+ post_install_message:
99
+ rdoc_options: []
100
+ require_paths:
101
+ - lib
102
+ required_ruby_version: !ruby/object:Gem::Requirement
103
+ requirements:
104
+ - - ">="
105
+ - !ruby/object:Gem::Version
106
+ version: '0'
107
+ required_rubygems_version: !ruby/object:Gem::Requirement
108
+ requirements:
109
+ - - ">="
110
+ - !ruby/object:Gem::Version
111
+ version: '0'
112
+ requirements: []
113
+ rubyforge_project:
114
+ rubygems_version: 2.5.1
115
+ signing_key:
116
+ specification_version: 4
117
+ summary: Simple Ruby class library for Telegram's Bot API
118
+ test_files: []