protonbot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b2fecb97495ccfcc14a68b256a2d0333ea2fee2
+  data.tar.gz: 9fa5a77d24a729f5fe20b05c03902b8928bc8efb
+SHA512:
+  metadata.gz: 299ee28b838107170e2e2de59a4a1a75745194a8d7d973ec7dccdb50701dc1b4e23f7cb2daa0475c407178ed3bc089fb9d128cb8d10f9dd63f7714c6022a4ad7
+  data.tar.gz: 88cb469c9f7b42b49ddda112c1100fa35af92e4875cdb01ea32213ee9f73c59e3365adab0fa1dd405dc07f8caadff6f213df3c80ecec953de0aaad51fb07d10d

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.sublime*
+/bottest/
+TODO

data/.rubocop.yml

@@ -0,0 +1,38 @@
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Security/Eval:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/LambdaCall:
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nickolay02@inbox.ru. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/CONFIG.md

@@ -0,0 +1,45 @@
+Full-fledged config-hash looks like that:
+
+```ruby
+{
+  # Global section. Basically sets default values for server-hashes
+  'global': {
+    'user' => 'ProtonBot',
+    'nick' => 'YetAnotherBot',
+    'rnam' => 'An IRC bot in Ruby' # `rnam` is shortened version of `realname`
+  },
+  # Define servers here
+  'servers' => {
+    'server1' => {}, # Will use default config
+    'server2' => {
+      'host' => 'irc.foo.bar.ru',
+      'port' => 6697,
+      'pass' => 'example_password',
+      'encoding' => 'koi-8r',
+      'cmdchar' => '%',
+      'autojoin' => ['#protonbot'],
+      'ssl' => true, # This is how you can use SSL
+      'ssl_crt' => './server2.crt',
+      'ssl_key' => './server2.key'
+    }
+  }
+}
+```
+
+Server-Hashes are merged in next way: `default.merge(global).merge(server)`
+
+Default server-hash:
+
+```ruby
+{
+  'host' => '127.0.0.1',
+  'port' => 6667,
+  'user' => 'ProtonBot',
+  'nick' => 'ProtonBot',
+  'rnam' => 'An IRC bot in Ruby',
+  'queue_delay' => 0.7,
+  'cmdchar' => '\\',
+  'encoding' => 'UTF-8',
+  'autojoin' => []
+}
+```

data/CORE_PLUGIN.md

@@ -0,0 +1,128 @@
+Finish this, write other stuff, allow requesting multiple permissions, fix YARD, and after - publish gem.
+
+# Core Plugin
+Core plugin implements features which are essential for bot to exist: hooks (including ping-response), command engine, permission system, help system etc.
+
+Core plugin can be accessed by using `core` (or `@core`) attr-reader.
+
+## APIs
+Here you can find documentation for core-plugin's APIs. Use them in your plugins.
+
+### Permissions
+Core plugin implements permission system - it allows checking user's permissions, editing them, preventing users from running stuff without permission.
+
+Permissions are stored and checked by hostname - so ensure that target user has stable hostmask (static IP address or freenode-like host cloak)
+
+Checking permissions is done by using `ProtonBot::Hook#perm!(*perms_to_check)` after defining hook. For example:
+
+```ruby
+cmd(cmd: 'sample_command') do |dat| # Defining hook. This time - command.
+  # Do something...
+end.perm!('perm1') # Applying #perm! method which adds permission 
+                   # checks before running hook.
+
+# You can also request more than one permission by simply passing more arguments
+
+cmd(cmd: 'whatever_command') do |dat|
+  dat.reply 'Foo!'
+end.perm!('foo', 'bar') # This command requires both `foo` and `bar` permissions
+
+```
+
+There's no need to define new permissions, but you may want to have own permission group where you'll find all your permissions. These act like normal permissions, but they are expanded into their members while checking permissions
+
+```ruby
+# Create permission group 'my_plugin' which will give all perms mentioned above
+core.permhash['my_plugin'] = %w(perm1 foo bar)
+# Add our permission group to 'admin' group so every admin will have access to these permissions
+core.permhash['admin'] << 'my_plugin'
+```
+
+Default permission hash:
+
+```ruby
+{
+  'owner' => %w(
+    reload
+    eval
+    exec
+    raw
+    cross
+    admin
+    perms
+  ),
+  'admin' => %w(
+    joinpart
+    nick
+    msg
+    ctcp
+    notice
+    nctcp
+    flushq
+  ),
+  'cross' => %w(
+    crossuser
+    crosschan
+    crossplug
+  )
+}
+```
+
+### Help
+Core plugin implements help system. To add help for new command, just use `core.help_add(group_name, command_name, syntax, description)`:
+
+```ruby
+core.help_add('group_name', 'hello', 'hello [nickname]', 'Say hello!')
+
+# How arguments are marked:
+# <required> 
+# [optional]
+# {0 or more}
+# (1 or more)
+```
+
+## Commands
+This is list of available commands. Use help engine for more info.
+
+### Basic commands
+1. `ping`
+2. `echo {message}`
+
+### Admin commands
+1. `key [key]`
+2. `nick <nick>`
+3. `msg [target] <message>`
+4. `notice [target] <message>`
+5. `ctcp [target] <message>`
+6. `nctcp [target] <message>`
+7. `flushq`
+8. `join (chans|sep=,) [pass]`
+9. `part (chans|sep=,) [reason]`
+
+### Owner commands
+1. `rb {code}`
+2. `eval {command}`
+3. `raw {message}`
+4. `r`
+
+### Permission-management commands
+1. `perms {groups}`
+2. `uperms <+|-|?> <user> {perms}`
+
+### Cross commands
+1. `as`
+2. `at`
+3. `on`
+
+### Help commands
+1. `help {commands}`
+2. `list {groups}` 
+
+## Emitted events (except for `raw`, which is emitted by plug)
+1. `privmsg` (parameters - `nick`, `user`, `host`, `target`, `reply_to`, `message`)`
+2. `notice` (same as with `privmsg`, but without `reply_to`)
+3. `ctcp` and `nctcp` (have `split` and `cmd` so you can parse them)
+4. `command` (inherited from PRIVMSG; parameters - `split` (array), `cmd`)
+5. `ukick`, `unick`, `upart`, `ujoin`, `uquit`
+6. `utopic` (unused)
+7. `ping`

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+ruby '2.4.0'
+
+# Specify your gem's dependencies in protonbot.gemspec
+gem 'protonbot-chanop', '~> 0.1.0'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Nickolay
+
+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/PLUGIN.md

@@ -0,0 +1,45 @@
+# Plugin-development-tutorial
+
+## Preparing environment
+You have 2 ways of creating plugins:
+
+### Gem. This way is recommended.
+Create gem by doing `bundler gem <gemname>`. Ensure that this name is not taken on https://rubygems.org.
+
+Create `lib/<gemname>/plugin.rb` file, where `gemname` - name of your gem with `-` replaced with `/`:
+
+```ruby
+# Your requires here...
+
+ProtonBot::Plugin.new do
+  @name = 'My first plugin'
+  @version = MyAmazingGem::VERSION
+  @description = 'Yay! First plugin!'
+
+  # Adding permissions using permission API (described in core_plugin.md)
+  core.permhash['admin'] << 'my_new_plugin'
+  core.permhash['my_new_plugin'] = %w(
+    my_sample_permission
+  )
+
+  # Hooking to `001` (WELCOME) code:
+  hook(type: :code, code: @numeric::WELCOME) do |dat|
+    # Do something...
+  end
+
+  # Hooking to command `ohaider`. This command cannot be run by users without
+  # permission 'my_sample_permission'
+  cmd(cmd: 'ohaider') do |dat|
+    dat.reply "Ohaider! Your nickname: #{dat[:nick]}. " +
+      "Your username: #{dat[:plug].getuser(dat[:nick])}. " +
+      "Your hostname: #{dat[:plug].gethost(dat[:nick])}. "
+  end.perm!('my_sample_permission')
+end
+```
+
+Command arguments can always be accessed by `dat[:split]` array.
+
+Now you just need to install your gem (`rake install`) and add it to bot by writing `gem 'gemname'` in `plugin_loader` statement
+
+### Folder in plugins/ directory
+Same as above, but instead of creating new gem, you are just creating folder `plugins/folder_name` and adding `plugin('folder_name')` to `plugin_loader` statement

data/README.md

@@ -0,0 +1,81 @@
+# Protonbot
+
+
+## Making basic bot
+
+This small guide covers making working bot with YAML config
+
+Create Gemfile with next content:
+
+```ruby
+ruby '2.4.0'
+source 'https://rubygems.org'
+gem 'protonbot'
+# gem 'protonbot-chanop' # If you want channel-operator commands
+```
+
+Execute `bundler install`
+
+Create `main.rb` with next content:
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'protonbot'
+require 'yaml'
+
+ProtonBot::Bot.new do
+  configure do
+    gset YAML.load_file(File.expand_path('./conf.yml'))
+  end
+
+  plugin_loader do
+    # gem 'protonbot-chanop' # If you want channel-operator commands
+  end
+end
+```
+
+Create `conf.yml` with content like next: (just remove first 3 lines and omit `port` to disable SSL connection)
+
+```yaml
+servers:
+  servername:
+    ssl: true
+    ssl_crt: ./example.crt
+    ssl_key: ./example.key
+    host: irc.example.net
+    port: 6697
+    autojoin:
+      - "#channel"
+```
+
+If you need an SSL certificate, just run `protonbot-gencert <name>`. You need OpenSSL executable for that.
+
+Start bot by doing `bundler exec ./main.rb`
+
+## Usage
+
+After you have started your bot, you need to gain permissions.
+
+1. Ensure that your hostname is not dynamic. If you have no static IP for that,
+  get a host cloak on your NickServ account.
+2. Send `\key` command to your bot (where `\` - your command char).
+3. Check your terminal to find key there.
+4. Send `\key <key>` to your bot, where `<key>` - generated key.
+5. Now you have owner permissions. To receive help, send `\help` to your bot.
+
+## Development
+
+After checking out the repo, run `bundler` to install dependencies. `bottest` directory is .gitignored, so you can make test bot there.
+
+To install this gem onto your local machine, run `bundler exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundler exec rake release \[origin\]`, 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/handicraftsman/protonbot. 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.
+
+
+## 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,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

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

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby
+if ARGV[0]
+  `openssl req -x509 -new -newkey rsa:4096 -sha256 -days 1000 -nodes -out #{ARGV[0]}.crt -keyout #{ARGV[0]}.key`
+else
+  puts 'No filename provided!'
+  puts "Usage: protonbot-cert <filename>"
+end

data/lib/protonbot/bot.rb

@@ -0,0 +1,64 @@
+# Main bot class. Use it to create the bot
+class ProtonBot::Bot
+  attr_reader :log, :_log, :dbs, :plugins, :conf, :plugs, :plugthrs
+
+  # @yield Main bot's block. You'll use it for configuring bot.
+  def initialize(&block)
+    @_log = ProtonBot::Log.new
+    @log = @_log.wrap('main')
+    @log.info('Hi there!')
+
+    instance_exec(&block)
+    @log.info('Processed main block')
+
+    @conf = {}
+    configure
+    @log.info('Processed config block')
+
+    @plugins = {}
+    plugins_load
+    @log.info('Processed plugins block')
+
+    @dbs = {}
+    @plugs = {}
+    @plugthrs = {}
+    Dir.mkdir('dbs/') unless File.exist?(File.expand_path('./dbs/'))
+    @conf['servers'].each do |k_, v_|
+      k = k_.clone
+      v = v_.clone
+      @plugthrs[k] = Thread.new do
+        @dbs[k] = Heliodor::DB.new("dbs/#{k}.db", true) unless k.nil?
+        @plugs[k] = ProtonBot::Plug.new(self, k.clone, v.clone)
+        begin
+          @plugs[k].connect! if v['enabled'] || v['enabled'].nil?
+        rescue => e
+          @plugs[k].log_err(e)
+        end
+      end
+    end
+
+    Signal.trap('INT') do
+      @plugs.each do |_k, v|
+        @log.info('Stopping...')
+        v.write_('QUIT :Stopping...')
+        v.running = false
+      end
+      @_log.stop
+      exit
+    end
+
+    @plugthrs.each do |_k, v|
+      v.join
+    end
+
+    @_log.stop
+  end
+
+  def inspect
+    %(<#ProtonBot::Bot:#{object_id.to_s(16)}>)
+  end
+
+  module Messages
+    NOT_ENOUGH_PARAMETERS = 'Not enough parameters!'.freeze
+  end
+end

data/lib/protonbot/bot_conf.rb

@@ -0,0 +1,48 @@
+class ProtonBot::Bot
+  attr_reader :conf
+
+  # @!group Config
+
+  # Default server-config
+  DEFAULT_SERVER_CONFIG = {
+    'host' => '127.0.0.1',
+    'port' => 6667,
+    'user' => 'ProtonBot',
+    'nick' => 'ProtonBot',
+    'rnam' => 'An IRC bot in Ruby',
+    'queue_delay' => 0.7,
+    'cmdchar' => '\\',
+    'encoding' => 'UTF-8',
+    'autojoin' => []
+  }.freeze
+
+  # @yield Do your config-loading here
+  # @see https://github.com/handicraftsman/heliodor/blob/master/config.md
+  #   Config-description
+  def configure(&block)
+    if block
+      @configure_block = block
+    else
+      @configure_block.call if @configure_block
+      set 'tsafe', true
+      @conf['servers'].each do |k, v|
+        @conf['servers'][k] =
+          DEFAULT_SERVER_CONFIG.merge(@conf['global'].to_h).merge(v.to_h)
+      end
+    end
+  end
+
+  # @param dat [Hash] Sets config variable to given value
+  def gset(dat)
+    raise(ArgumentError, '`dat` is not hash!') unless dat.instance_of?(Hash)
+    @conf = dat
+  end
+
+  # Binds `val` to `key` in `@conf`
+  # @param key [Symbol]
+  # @param val [Object]
+  def set(key, val)
+    @conf[key.to_sym] = val
+  end
+  # @!endgroup
+end