codebot 1.2.0

data/Rakefile

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+task default: :check
+
+begin
+  Bundler.setup :development
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems.'
+  exit e.status_code
+end
+
+task :check do
+  Rake::Task[:spec].execute
+  Rake::Task[:lint].execute
+end
+
+RSpec::Core::RakeTask.new :spec do |task|
+  task.ruby_opts = '-E UTF-8'
+end
+
+RuboCop::RakeTask.new :lint

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'codebot'
+require 'irb'
+
+IRB.start(__FILE__)

data/codebot.gemspec

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'codebot/metadata'
+
+def description
+  text = <<-DESCRIPTION
+    Codebot is an IRC bot that receives GitHub webhooks and forwards them to
+    IRC channels. It is designed to send messages in a format similar to that
+    of the official GitHub IRC Service. Codebot is able to stay connected after
+    sending messages. This eliminates the delays and visual clutter caused by
+    reconnecting each time a new message has to be delivered.
+  DESCRIPTION
+  text.gsub(/\s+/, ' ').strip
+end
+
+Gem::Specification.new do |spec|
+  spec.name          = 'codebot'
+  spec.version       = Codebot::VERSION
+  spec.authors       = ['Janik Rabe', 'Ola Bini']
+  spec.email         = ['codebot@olabini.se']
+  spec.summary       = 'Forward GitHub webhooks to IRC channels'
+  spec.description   = description
+  spec.homepage      = 'https://github.com/olabini/codebot'
+
+  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.license       = 'MIT'
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.2.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'rubocop', '~> 0.65.0'
+
+  spec.add_runtime_dependency 'cinch', '~> 2.3'
+  spec.add_runtime_dependency 'cinch-identify', '~> 1.7'
+  spec.add_runtime_dependency 'irb', '~> 1.0'
+  spec.add_runtime_dependency 'sinatra', '~> 2.0'
+  spec.add_runtime_dependency 'thor', '~> 0.20.0'
+end

data/exe/codebot

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'codebot'
+require 'codebot/user_error'
+
+Codebot::Options::Base.start(ARGV)

data/lib/codebot.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# This is the main module for Codebot.
+module Codebot end
+
+require 'codebot/metadata'
+require 'codebot/options'
+require 'codebot/core'

data/lib/codebot/channel.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require 'codebot/sanitizers'
+require 'codebot/serializable'
+
+module Codebot
+  # This class represents an IRC channel notifications can be delivered to.
+  class Channel < Serializable
+    include Sanitizers
+
+    # @return [String] the name of this channel
+    attr_reader :name
+
+    # @return [Network] the network this channel belongs to
+    attr_reader :network
+
+    # @return [String, nil] the key required for joining this channel
+    attr_reader :key
+
+    # @return [Boolean] whether to send messages without joining this channel
+    attr_reader :send_external
+
+    # Creates a new channel from the supplied hash.
+    #
+    # @param params [Hash] A hash with symbolic keys representing the instance
+    #                      attributes of this channel. The keys +:name+ and
+    #                      +:network+ are required. Alternatively, the key
+    #                      +:identifier+, which should use the format
+    #                      +network/name+, can be specified.
+    def initialize(params)
+      update!(params)
+    end
+
+    # Updates the channel from the supplied hash.
+    #
+    # @param params [Hash] A hash with symbolic keys representing the instance
+    #                      attributes of this channel.
+    def update!(params)
+      set_identifier params[:identifier], params[:config] if params[:identifier]
+      self.name          = params[:name]
+      self.key           = params[:key]
+      self.send_external = params[:send_external]
+      set_network params[:network], params[:config]
+    end
+
+    def name=(name)
+      @name = valid! name, valid_channel_key(name), :@name,
+                     required: true,
+                     required_error: 'channels must have a name',
+                     invalid_error: 'invalid channel name %s'
+    end
+
+    # Sets the network for this channel.
+    #
+    # @param network [String] the name of the network
+    # @param conf [Hash] the configuration containing all networks
+    def set_network(network, conf)
+      @network = valid! network, valid_network(network, conf), :@network,
+                        required: true,
+                        required_error: 'channels must have a network',
+                        invalid_error: 'invalid channel network %s'
+    end
+
+    def key=(key)
+      @key = valid! key, valid_channel_key(key), :@key,
+                    invalid_error: 'invalid channel key %s'
+    end
+
+    def key?
+      !key.to_s.strip.empty?
+    end
+
+    def send_external=(send_external)
+      @send_external = valid!(send_external, valid_boolean(send_external),
+                              :@send_external,
+                              invalid_error: 'send_external must be a ' \
+                                             'boolean') { false }
+    end
+
+    # Checks whether the identifier of this channel is equal to another
+    # identifier.
+    #
+    # @param identifier [String] the other identifier
+    # @return [Boolean] +true+ if the names are equal, +false+ otherwise
+    def identifier_eql?(identifier)
+      self.identifier.casecmp(identifier).zero?
+    end
+
+    # Returns the string used to identify this channel in configuration files.
+    #
+    # @return [String] the identifier
+    def identifier
+      "#{@network.name}/#{@name}"
+    end
+
+    # Sets network and channel name based on the given identifier.
+    #
+    # @param identifier [String] the identifier
+    # @param conf [Hash] the configuration containing all networks
+    def set_identifier(identifier, conf)
+      network_name, self.name = identifier.split('/', 2) if identifier
+      set_network(network_name, conf)
+    end
+
+    # Serializes this channel.
+    #
+    # @param _conf [Hash] the deserialized configuration
+    # @return [Array, Hash] the serialized object
+    def serialize(_conf)
+      [identifier, {
+        'key' => key,
+        'send_external' => send_external
+      }]
+    end
+
+    # Deserializes a channel.
+    #
+    # @param identifier [String] the channel identifier
+    # @param data [Hash] the serialized data
+    # @return [Hash] the parameters to pass to the initializer
+    def self.deserialize(identifier, data)
+      {
+        identifier: identifier,
+        key: data['key'],
+        send_external: data['send_external']
+      }
+    end
+
+    # @return [true] to indicate that data is serialized into a hash
+    def self.serialize_as_hash?
+      true
+    end
+  end
+end

data/lib/codebot/command_error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'codebot/user_error'
+
+module Codebot
+  # This exception stores information about an error that occurred due to the
+  # user entering an invalid command, for example when two mutually exclusive
+  # command-line options are specified.
+  class CommandError < UserError
+    # Constructs a new command error.
+    #
+    # @param message [String] the error message
+    def initialize(message)
+      super
+    end
+  end
+end

data/lib/codebot/config.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'psych'
+
+require 'codebot/channel'
+require 'codebot/integration'
+require 'codebot/network'
+
+module Codebot
+  # This class manages a Codebot configuration file.
+  class Config
+    # @return [Core] the bot this configuration belongs to
+    attr_reader :core
+
+    # @return [String] the path to the managed configuration file
+    attr_reader :file
+
+    # Creates a new instance of the class and loads the configuration file.
+    #
+    # @param core [Core] the bot this configuration belongs to
+    # @param file [String] the path to the configuration file, or +nil+ to
+    #                      use the default configuration file for this user
+    def initialize(core, file = nil)
+      @core = core
+      @file = file || self.class.default_file
+      @semaphore = Mutex.new
+      unsafe_load
+    end
+
+    # Loads the configuration from the associated file. If the file does not
+    # exist, it is created.
+    def load!
+      transaction { unsafe_load }
+    end
+
+    # A thread-safe method for making changes to the configuration. If another
+    # transaction is active, the calling thread waits for it to complete.
+    # If a +StandardError+ occurs during the transaction, the configuration
+    # is rolled back to the previous state.
+    #
+    # @yield invokes the given block during the transaction
+    # @raise [StandardError] the error that occurred during modification
+    # @return [true] if the transaction completes successfully
+    def transaction
+      @semaphore.synchronize do
+        state = @conf
+        begin
+          run_transaction(&Proc.new)
+        rescue StandardError
+          @conf = state
+          raise
+        end
+      end
+    end
+
+    # @return [Array] the integrations contained in this configuration
+    def integrations
+      @conf[:integrations]
+    end
+
+    # @return [Array] the networks contained in this configuration
+    def networks
+      @conf[:networks]
+    end
+
+    # Returns the path to the default configuration file for the current user.
+    #
+    # @return [String] the path to the configuration file
+    def self.default_file
+      File.join Dir.home, '.codebot.yml'
+    end
+
+    private
+
+    # Saves the current configuration to the configuration file.
+    def save!
+      save_to_file! @file
+    end
+
+    # Loads the configuration file without starting a transaction.
+    def unsafe_load
+      @conf = load_from_file! @file
+      save! unless File.file? @file
+    end
+
+    # Makes changes to the configuration, saves the file and requests that the
+    # bot migrate to the new version.
+    #
+    # @note This method should only be called by the {#transaction} method.
+    # @return [Boolean] +true+ if the transaction succeeded, +false+ otherwise
+    def run_transaction
+      yield
+      return false unless save!
+
+      @core.migrate!
+      true
+    end
+
+    # Loads the configuration from the specified file.
+    #
+    # @param file [String] the path to the configuration file
+    # @return [Hash] the loaded configuration, or the default configuration if
+    #                the file did not exist
+    def load_from_file!(file)
+      data = Psych.safe_load(File.read(file)) if File.file? file
+      data = {} unless data.is_a? Hash
+      conf = {}
+      conf[:networks]     = Network.deserialize_all data['networks'], conf
+      conf[:integrations] = Integration.deserialize_all data['integrations'],
+                                                        conf
+      conf
+    end
+
+    # Saves the configuration to the specified file.
+    #
+    # @param file [String] the path to the configuration file
+    def save_to_file!(file)
+      data = {}
+      data['networks']     = Network.serialize_all     @conf[:networks], @conf
+      data['integrations'] = Integration.serialize_all @conf[:integrations],
+                                                       @conf
+      File.write file, Psych.dump(data)
+    end
+  end
+end

data/lib/codebot/configuration_error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'codebot/user_error'
+
+module Codebot
+  # This exception stores information about an error that occurred due to an
+  # invalid configuration file, for example when an entry has the wrong data
+  # type.
+  class ConfigurationError < UserError
+    # Constructs a new configuration error.
+    #
+    # @param message [String] the error message
+    def initialize(message)
+      super
+    end
+  end
+end

data/lib/codebot/core.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'codebot/config'
+require 'codebot/irc_client'
+require 'codebot/web_server'
+require 'codebot/ipc_server'
+
+module Codebot
+  # This class represents a {Codebot} bot.
+  class Core
+    # @return [Config] the configuration used by this bot
+    attr_reader :config
+
+    # @return [IRCClient] the IRC client
+    attr_reader :irc_client
+
+    # @return [IRCClient] the web server
+    attr_reader :web_server
+
+    # @return [IRCClient] the IPC server
+    attr_reader :ipc_server
+
+    # Creates a new bot from the supplied hash.
+    #
+    # @param params [Hash] A hash with symbolic keys for initializing this
+    #                      instance. The only accepted keys are +:config_file+
+    #                      and +:ipc_pipe+. Any other keys are ignored.
+    def initialize(params = {})
+      @config     = Config.new(self, params[:config_file])
+      @irc_client = IRCClient.new(self)
+      @web_server = WebServer.new(self)
+      @ipc_server = IPCServer.new(self, params[:ipc_pipe])
+    end
+
+    # Starts this bot.
+    def start
+      @irc_client.start
+      @web_server.start
+      @ipc_server.start
+    end
+
+    # Stops this bot.
+    def stop
+      @ipc_server.stop
+      @web_server.stop
+      @irc_client.stop
+    end
+
+    # Waits for this bot to stop. If any of the managed threads finish early,
+    # the bot is shut down immediately.
+    def join
+      ipc = Thread.new { @ipc_server.join && stop }
+      web = Thread.new { @web_server.join && stop }
+      ipc.join
+      web.join
+      @irc_client.join
+    end
+
+    # Requests that the running threads migrate to an updated configuration.
+    def migrate!
+      @irc_client.migrate! unless @irc_client.nil?
+    end
+
+    # Sets traps for SIGINT and SIGTERM so Codebot can shut down gracefully.
+    def trap_signals
+      shutdown = proc do |signal|
+        STDERR.puts "\nReceived #{signal}, shutting down..."
+        stop
+        join
+        exit 1
+      end
+      trap('INT')  { shutdown.call 'SIGINT'  }
+      trap('TERM') { shutdown.call 'SIGTERM' }
+    end
+  end
+end