cinch-bot_template 0.1.0

data/lib/cinch/bot_template/templates/bot.rb

@@ -0,0 +1,157 @@
+require 'fileutils'
+module Cinch
+  module BotTemplate
+    module Templates
+      class Bot
+
+
+        def generate(multi:, config_file:)
+          cfg = config_file
+          if multi
+            bot = <<~BOT
+              #! /usr/bin/env ruby
+              require 'cinch'
+              require 'yaml'
+              require 'cinch/plugins/identify'
+              require 'cinch/plugins/basic_ctcp'
+
+              $cfg = YAML.load_file("#{cfg}")
+              $bots = Hash.new
+              $threads = Array.new
+              
+              $cfg['bot']['networks'].each do |name, ncfg|
+                bot = Cinch::Bot.new do
+                  configure do |c|
+                    c.server = ncfg.dig('server')
+                    c.port = ncfg.dig('port')
+                    c.nick = ncfg.dig('nickname')
+                    c.user = ncfg.dig('username')
+                    c.realname = ncfg.dig('realname')
+                    c.plugins.plugins << Cinch::Plugins::Identify
+                    identify_with = ncfg.fetch('identify-with')
+                    case identify_with
+                    when 'nickserv'
+                      begin
+                        c.plugins.options[Cinch::Plugins::Identify] = {
+                          :username => ncfg.fetch('sasl-username'),
+                          :password => ncfg.fetch('sasl-password'),
+                          :type     => :nickserv,
+                        }
+                      rescue KeyError
+                      end
+                    when 'sasl'
+                      begin
+                        c.sasl.username = ncfg.fetch('sasl-username')
+                        c.sasl.password = ncfg.fetch('sasl-password')
+                      rescue KeyError
+                      end
+                    when 'cert'
+                      begin
+                        c.ssl.client_cert = ncfg.fetch('certfp')
+                      rescue KeyError
+                      end
+                    end
+                    c.channels = ncfg.fetch('channels')
+                    c.ssl.use = ncfg.fetch('ssl')
+                    c.ssl.verify = ncfg.fetch('sslverify')
+                    c.messages_per_second = ncfg.fetch('mps')
+              
+                    c.plugins.plugins << Cinch::Plugins::BasicCTCP
+                    c.plugins.options[Cinch::Plugins::BasicCTCP][:replies] = {
+                        version: Bot.version
+                    }
+                  end
+                end
+                bot.loggers.clear
+
+                bot.loggers.level = :debug
+                $bots[name] = bot
+              end
+              $bots.each do |key, bot|
+                puts "Starting IRC connection for \#{key}..."
+                $threads << Thread.new { bot.start }
+              end
+              
+              class Bot
+                def Bot.version
+                  $cfg['bot']['version']
+                end
+              end
+
+            BOT
+
+            bot
+          else
+            bot = <<~BOT
+              #! /usr/bin/env ruby
+              require 'cinch'
+              require 'yaml'
+              require 'cinch/plugins/identify'
+              require 'cinch/plugins/basic_ctcp'
+
+              $cfg = YAML.load_file("#{cfg}")
+              $threads = Array.new
+            
+              bot = Cinch::Bot.new do
+                configure do |c|
+                  c.server = $cfg.dig('bot', 'server')
+                  c.port = $cfg.dig('bot', 'port')
+                  c.nick = $cfg.dig('bot', 'nickname')
+                  c.user = $cfg.dig('bot', 'username')
+                  c.realname = $cfg.dig('bot', 'realname')
+                  c.plugins.plugins << Cinch::Plugins::Identify
+                  identify_with = $cfg.dig('bot', 'identify-with')
+                  case identify_with
+                  when 'nickserv'
+                    begin
+                      c.plugins.options[Cinch::Plugins::Identify] = {
+                        :username => $cfg.dig('bot', 'sasl', 'username'),
+                        :password => $cfg.fetch('bot','sasl', 'password'),
+                        :type     => :nickserv,
+                      }
+                    rescue KeyError
+                    end
+                  when 'sasl'
+                    begin
+                      c.sasl.username = $cfg.dig('bot', 'sasl', 'username')
+                      c.sasl.password = $cfg.dig('bot', 'sasl', 'password')
+                    rescue KeyError
+                    end
+                  when 'cert'
+                    begin
+                      c.ssl.client_cert = $cfg.dig('bot', 'cert')
+                    rescue KeyError
+                    end
+                  end
+                  c.channels = $cfg.dig('bot', 'channels')
+                  c.ssl.use = $cfg.dig('bot', 'use_ssl')
+                  c.ssl.verify = $cfg.dig('bot', 'use_ssl_verify')
+                  c.messages_per_second = $cfg.dig('bot', 'mps')
+            
+                  c.plugins.plugins << Cinch::Plugins::BasicCTCP
+                  c.plugins.options[Cinch::Plugins::BasicCTCP][:replies] = {
+                      version: Bot.version,
+                  }
+
+                  # Add more plugins here.
+                end
+                bot.loggers.clear
+
+                bot.loggers.level = :debug
+              end
+              $threads << Thread.new { bot.start }
+              
+              class Bot
+                def Bot.version
+                  $cfg['bot']['version']
+                end
+              end
+            BOT
+
+            bot
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cinch/bot_template/templates/config.rb

@@ -0,0 +1,58 @@
+require 'fileutils'
+module Cinch
+  module BotTemplate
+    module Templates
+      class Config
+        def generate(nick:, multi:, networks:)
+
+          if multi
+            head = "bot:\n  networks:\n"
+            body = []
+            networks.each do |network, server|
+              body <<
+<<-BODY
+    #{network}:
+      server: #{server}
+      port: 6697
+      use_ssl: true
+      use_ssl_verify: false
+      mps: 3.0
+      nickname: #{nick}
+      username: #{nick}
+      realname: #{nick}
+      identify-with: sasl
+      #cert: "/path/to/cert"
+      sasl:
+        username: #{nick}
+        password: PASSWORD
+      channels:
+      - "#chat"
+BODY
+            end
+            head + body.join
+
+          else
+<<-BOT
+bot:
+  server: #{networks}
+  port: 6697
+  use_ssl: true
+  use_ssl_verify: false
+  mps: 3.0
+  nickname: #{nick}
+  username: #{nick}
+  realname: #{nick}
+  identify-with: sasl
+  #cert: "/path/to/cert"
+  sasl:
+    username: #{nick}
+    password: PASSWORD
+  channels:
+  - "#chat"
+BOT
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cinch/bot_template/templates/hello.rb

@@ -0,0 +1,32 @@
+require 'fileutils'
+module Cinch
+  module BotTemplate
+    module Templates
+      class Hello
+        def generate(nick:)
+
+
+          hello = <<~HELLO
+          require 'cinch'
+
+          bot = Cinch::Bot.new do
+            configure do |c|
+              c.server = "irc.electrocode.net"
+              c.channels = ["#bots"]
+              c.nick = '#{nick}'
+            end
+
+            on :message, "hello" do |m|
+              m.reply "Hello, \#{m.user.nick}"
+            end
+          end
+
+          bot.start
+          HELLO
+
+          hello
+        end
+      end
+    end
+  end
+end

data/lib/cinch/bot_template/templates/plugin.rb

@@ -0,0 +1,30 @@
+require 'fileutils'
+require 'active_support/core_ext/string'
+module Cinch
+  module BotTemplate
+    module Templates
+      class Plugin
+        def Plugin.generate(plugin_names:)
+          plugins = {}
+          plugin_names.each do |plugin|
+            name = "#{plugin.capitalize}Plugin"
+
+            bot = <<~BOT
+            class #{name}
+              include Cinch::Plugin
+              match /^hello$/, method: :hello_world
+              # @param [Cinch::Message] m cinch message object
+              def hello_world(m)
+                m.reply "Hello \#{m.user.nick}"
+              end
+            end
+            BOT
+            plugins[plugin+'.rb'] = bot
+
+          end
+          plugins
+        end
+      end
+    end
+  end
+end

data/lib/cinch/bot_template/version.rb

@@ -0,0 +1,5 @@
+module Cinch
+  module BotTemplate
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: cinch-bot_template
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ken Spencer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cinch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.10
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+description: Generate cinch bot skeletons
+email:
+- me@iotaspencer.me
+executables:
+- cinch-mktpl
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/cinch-mktpl
+- cinch-bot_template.gemspec
+- lib/cinch/bot_template.rb
+- lib/cinch/bot_template/cinch-bot_template.rb
+- lib/cinch/bot_template/classes/bot.rb
+- lib/cinch/bot_template/classes/config.rb
+- lib/cinch/bot_template/classes/exceptions.rb
+- lib/cinch/bot_template/classes/gen_init.rb
+- lib/cinch/bot_template/classes/hello.rb
+- lib/cinch/bot_template/classes/plugin.rb
+- lib/cinch/bot_template/desc/bot.rb
+- lib/cinch/bot_template/desc/gen.rb
+- lib/cinch/bot_template/desc/hello.rb
+- lib/cinch/bot_template/desc/plugin.rb
+- lib/cinch/bot_template/main/bot.rb
+- lib/cinch/bot_template/main/cli.rb
+- lib/cinch/bot_template/main/config.rb
+- lib/cinch/bot_template/main/desc.rb
+- lib/cinch/bot_template/main/plugin.rb
+- lib/cinch/bot_template/main/spinner.rb
+- lib/cinch/bot_template/main/thor.rb
+- lib/cinch/bot_template/templates/bot.rb
+- lib/cinch/bot_template/templates/config.rb
+- lib/cinch/bot_template/templates/hello.rb
+- lib/cinch/bot_template/templates/plugin.rb
+- lib/cinch/bot_template/version.rb
+homepage: https://github.com/IotaSpencer/cinch-bot_template
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+  - - "<="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Generate cinch bot skeletons
+test_files: []