codebot 1.2.0

data/lib/codebot/thread_controller.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Codebot
+  # This class provides a consistent interface for subclasses that manage a
+  # thread.
+  class ThreadController
+    # Creates a new thread controller.
+    def initialize
+      @thread = nil
+    end
+
+    # Suspends execution of the calling thread until the managed thread exits.
+    #
+    # @return [Thread, nil] the dead thead, or +nil+ if no thread was active
+    def join
+      @thread.join if running?
+    end
+
+    # Checks whether the managed thread is currently running.
+    #
+    # @return [Boolean] +true+ if the managed thread is alive,
+    #                   +false+ otherwise
+    def running?
+      !@thread.nil? && @thread.alive?
+    end
+
+    # Starts a new managed thread if no thread is currently running.
+    # The thread invokes the +run+ method of the class that manages it.
+    #
+    # @param arg the argument to pass to the +#run+ method
+    # @return [Thread, nil] the newly created thread, or +nil+ if
+    #                       there was already a running thread
+    def start(arg = nil)
+      return if running?
+
+      @thread = Thread.new do
+        Thread.current.abort_on_exception = true
+        run(arg)
+      end
+    end
+
+    # Starts a new managed thread. The thread invokes the +run+ method of the
+    # class that manages it.
+    #
+    # @param arg the argument to pass to the +run+ method
+    # @return [Thread] the newly created thread
+    # @raise [RuntimeError] if there was already a running thread
+    def start!(arg = nil)
+      raise "#{self.class.name} is already running" unless start(arg)
+    end
+
+    # Stops the managed thread if a thread is currently running.
+    #
+    # @return [Thread, nil] the stopped thread, or +nil+ if
+    #                       no thread was running
+    def stop
+      return unless running?
+
+      @thread.exit
+    end
+
+    # Stops the managed thread.
+    #
+    # @return [Thread] the stopped thread
+    # @raise [RuntimeError] if there was no running thread
+    def stop!
+      raise "#{self.class.name} is already stopped" unless stop
+    end
+  end
+end

data/lib/codebot/user_error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Codebot
+  # This class serves as a parent class for errors caused by user actions.
+  class UserError < RuntimeError
+    # Constructs a new user error.
+    #
+    # @param message [String] the error message
+    def initialize(message)
+      super
+    end
+  end
+end

data/lib/codebot/validation_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 a
+  # failed validation, for example when a network with an invalid name is
+  # created.
+  class ValidationError < UserError
+    # Constructs a new validation error.
+    #
+    # @param message [String] the error message
+    def initialize(message)
+      super
+    end
+  end
+end

data/lib/codebot/web_listener.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'codebot/cryptography'
+require 'codebot/event'
+require 'codebot/integration_manager'
+require 'codebot/request'
+
+module Codebot
+  # This module provides methods for processing incoming webhooks and
+  # dispatching them to the IRC client.
+  module WebListener
+    # Handles a POST request.
+    #
+    # @param core [Core] the bot to dispatch requests to
+    # @param request [Sinatra::Request] the request to handle
+    # @param params [Hash] the request parameters
+    def handle_post(core, request, params)
+      payload = params['payload'] || request.body.read
+      dispatch(core, request, *params['splat'], payload)
+    rescue JSON::ParserError
+      [400, 'Invalid JSON payload']
+    end
+
+    # Finds the integration associated with an endpoint.
+    #
+    # @param config [Config] the configuration containing the integrations
+    # @param endpoint [String] the endpoint
+    def integration_for(config, endpoint)
+      IntegrationManager.new(config).find_integration_by_endpoint(endpoint)
+    end
+
+    # Dispatches a received payload to the IRC client.
+    #
+    # @param core [Core] the bot to dispatch this request to
+    # @param request [Sinatra::Request] the request received by the web server
+    # @param endpoint [String] the endpoint at which the request was received
+    # @param payload [String] the payload that was sent to the endpoint
+    # @return [Array<Integer, String>] HTTP status code and response
+    def dispatch(core, request, endpoint, payload)
+      intg = integration_for(core.config, endpoint)
+      return [404, 'Endpoint not registered'] if intg.nil?
+      return [403, 'Invalid signature'] unless valid?(request, intg, payload)
+
+      req = create_request(intg, request, payload)
+      return req if req.is_a? Array
+
+      core.irc_client.dispatch(req)
+      [202, 'Accepted']
+    end
+
+    def create_gitlab_event(request)
+      event = request.env['HTTP_X_GITLAB_EVENT']
+      return [400, 'Missing event header'] if event.nil? || event.empty?
+
+      Event.symbolize("Gitlab #{event}".tr(' ', '_'))
+    end
+
+    def create_github_event(request)
+      event = request.env['HTTP_X_GITHUB_EVENT']
+      return [400, 'Missing event header'] if event.nil? || event.empty?
+
+      Event.symbolize(event)
+    end
+
+    # Creates a new request for the webhook.
+    #
+    # @param integration [Integration] the integration for which the request
+    #                                  was made
+    # @param request [Sinatra::Request] the request received by the web server
+    # @param payload [String] the payload that was sent to the endpoint
+    # @return [Request, Array<Integer, String>] the created request, or an
+    #                                           array containing HTTP status
+    #                                           code and response if the
+    #                                           request was invalid
+    def create_request(integration, request, payload)
+      event = if integration.gitlab
+                create_gitlab_event(request)
+              else
+                create_github_event(request)
+              end
+      return event if event.is_a? Array
+
+      return [501, 'Event not yet supported'] if event.nil?
+
+      Request.new(integration, event, payload)
+    end
+
+    # Verifies a webhook signature.
+    #
+    # @param request [Sinatra::Request] the request received by the web server
+    # @param integration [Integration] the integration for which the request
+    #                                  was made
+    # @param payload [String] the payload that was sent to the endpoint
+    # @return [Boolean] whether the signature is valid
+    def valid?(request, integration, payload)
+      return true unless integration.verify_payloads?
+
+      secret = integration.secret
+      if integration.gitlab
+        secret == request.env['HTTP_X_GITLAB_TOKEN']
+      else
+        request_signature = request.env['HTTP_X_HUB_SIGNATURE']
+        Cryptography.valid_signature?(payload, secret, request_signature)
+      end
+    end
+  end
+end

data/lib/codebot/web_server.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'codebot/thread_controller'
+require 'codebot/web_listener'
+require 'codebot/user_error'
+
+require 'sinatra'
+
+module Codebot
+  # This class manages a {WebListener} that runs in a separate thread.
+  class WebServer < ThreadController
+    extend Sanitizers
+
+    # Creates a new web server.
+    #
+    # @param core [Core] the bot this server belongs to
+    def initialize(core)
+      @core = core
+    end
+
+    # Starts this web server.
+    def run(*)
+      create_server.run!
+    end
+
+    # Creates a +Proc+ for configuring this web server.
+    #
+    # @return [Proc] the proc
+    def self.configuration
+      server = self
+      proc do
+        disable :traps
+        set :bind, ENV['CODEBOT_BIND'] unless ENV['CODEBOT_BIND'].to_s.empty?
+        port = ENV['CODEBOT_PORT']
+        if port.is_a?(String) && !port.empty?
+          set :port, (server.valid! port, server.valid_port(port), nil,
+                                    invalid_error: 'invalid port %s')
+        end
+      end
+    end
+
+    private
+
+    # Creates a new Sinatra server for handling incoming requests.
+    #
+    # @return [Class] the created server
+    def create_server
+      core = @core
+      Sinatra.new do
+        include WebListener
+
+        configure { instance_eval(&WebServer.configuration) }
+        post('/*') { handle_post(core, request, params) }
+        error(Sinatra::NotFound) { [405, 'Method not allowed'] }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,249 @@
+--- !ruby/object:Gem::Specification
+name: codebot
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Janik Rabe
+- Ola Bini
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.65.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.65.0
+- !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: cinch-identify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+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.
+email:
+- codebot@olabini.se
+executables:
+- codebot
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/ISSUE_TEMPLATE/formatter_issue.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- codebot.gemspec
+- exe/codebot
+- lib/codebot.rb
+- lib/codebot/channel.rb
+- lib/codebot/command_error.rb
+- lib/codebot/config.rb
+- lib/codebot/configuration_error.rb
+- lib/codebot/core.rb
+- lib/codebot/cryptography.rb
+- lib/codebot/event.rb
+- lib/codebot/ext/cinch/ssl_extensions.rb
+- lib/codebot/formatter.rb
+- lib/codebot/formatters.rb
+- lib/codebot/formatters/.rubocop.yml
+- lib/codebot/formatters/commit_comment.rb
+- lib/codebot/formatters/fork.rb
+- lib/codebot/formatters/gitlab_issue_hook.rb
+- lib/codebot/formatters/gitlab_job_hook.rb
+- lib/codebot/formatters/gitlab_merge_request_hook.rb
+- lib/codebot/formatters/gitlab_note_hook.rb
+- lib/codebot/formatters/gitlab_pipeline_hook.rb
+- lib/codebot/formatters/gitlab_push_hook.rb
+- lib/codebot/formatters/gitlab_wiki_page_hook.rb
+- lib/codebot/formatters/gollum.rb
+- lib/codebot/formatters/issue_comment.rb
+- lib/codebot/formatters/issues.rb
+- lib/codebot/formatters/ping.rb
+- lib/codebot/formatters/public.rb
+- lib/codebot/formatters/pull_request.rb
+- lib/codebot/formatters/pull_request_review_comment.rb
+- lib/codebot/formatters/push.rb
+- lib/codebot/formatters/watch.rb
+- lib/codebot/integration.rb
+- lib/codebot/integration_manager.rb
+- lib/codebot/ipc_client.rb
+- lib/codebot/ipc_server.rb
+- lib/codebot/irc_client.rb
+- lib/codebot/irc_connection.rb
+- lib/codebot/message.rb
+- lib/codebot/metadata.rb
+- lib/codebot/network.rb
+- lib/codebot/network_manager.rb
+- lib/codebot/options.rb
+- lib/codebot/options/base.rb
+- lib/codebot/options/core.rb
+- lib/codebot/options/integration.rb
+- lib/codebot/options/network.rb
+- lib/codebot/payload.rb
+- lib/codebot/request.rb
+- lib/codebot/sanitizers.rb
+- lib/codebot/serializable.rb
+- lib/codebot/shortener.rb
+- lib/codebot/thread_controller.rb
+- lib/codebot/user_error.rb
+- lib/codebot/validation_error.rb
+- lib/codebot/web_listener.rb
+- lib/codebot/web_server.rb
+- webhook.png
+homepage: https://github.com/olabini/codebot
+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.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Forward GitHub webhooks to IRC channels
+test_files: []