codebot 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: afdf8aa17931f5664a340884f1aa57e54b504d145473dd80ead27a475562ac34
+  data.tar.gz: 6fa0fc77a5a4373e608dc29fbc68b415bc9260d462c54aad810d8335f1e0a5ac
+SHA512:
+  metadata.gz: 8db55c49dd1a113c594707f5fc1f84445b3867a7a80a2d34ae86ca1f93b278be302f357b5c93ed5bca1d77bcbea6c05d211b0367315c19858dab3fd8798f53ca
+  data.tar.gz: 294e854c4c7c94723080374466dd1322728faf7ae2475f61995e279dfc31b16688571336e81137c395e61ba4964d1e829b497cc4dcae14edbad33e2798a992c1

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,32 @@
+## Expected Behavior
+
+<!-- If you're reporting a bug, explain what you expected to happen -->
+<!-- If you're suggesting an improvement, please elaborate on your idea -->
+
+## Actual Behavior
+
+<!-- Describe how the current behavior differs from what you expected -->
+
+## Proposed Solution
+
+<!-- Explain how the change could be implemented, or delete this section -->
+
+## Steps to Reproduce
+
+<!-- Unless you're reporting a bug, please delete this section -->
+
+1. ?
+2. ?
+3. ?
+
+## Ruby Version
+
+<!-- Unless you're reporting a bug, please delete this section -->
+
+```
+Please replace this line with the output of `ruby --version`
+```
+
+## Additional Information
+
+<!-- If you have any other comments, please add them here -->

data/.github/ISSUE_TEMPLATE/formatter_issue.md

@@ -0,0 +1,20 @@
+<!--
+  If you received a notification that started with "An error occurred while
+  formatting this message", please report the issue here.
+
+  If you're not the owner of the bot, please ask the owner to open an issue
+  instead.
+-->
+
+## Error Report
+
+<!-- If you used the `codebot core interactive` command, an error report should
+     have been printed to `stderr` (the standard error stream). If you don't
+     know how to find it, don't worry — we're here to help! -->
+
+<!-- Replace this line with the error report if you have one. -->
+
+## Additional Information
+
+<!-- If you know which event led to this issue or have any other information
+     that might be useful, please include it here. -->

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+## Description
+
+<!-- Please describe your changes in detail -->
+<!-- If this pull request fixes an open issue, please link to it -->
+
+## Checklist
+
+<!-- Please put an "x" in all boxes that apply -->
+<!-- If you're not sure, don't hesitate to ask. We're here to help. -->
+
+- [ ] I have read the **CONTRIBUTING.md** file
+- [ ] I have updated any relevant documentation
+- [ ] I have run `rubocop` and no offenses were detected

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/examples.txt
+/spec/reports/
+/tmp/
+/vendor

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/IndentHeredoc:
+  EnforcedStyle: squiggly

data/.travis.yml

@@ -0,0 +1,26 @@
+sudo: false
+cache: bundler
+language: ruby
+dist: trusty
+rvm:
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
+  - ruby-head
+  - jruby-9.1.16.0
+  - jruby-head
+env:
+  global:
+    - JRUBY_OPTS='--debug -J-Xmx1000M'
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+  fast_finish: true
+before_install:
+  - gem update --system
+  - gem update --remote bundler
+install:
+  - bundle install --retry=3
+script:
+  - bundle exec rake check

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# 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 codebot@olabini.se. The project team will review and investigate all complaints, and will respond in a way that it deems 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/CONTRIBUTING.md

@@ -0,0 +1,15 @@
+# Contributing
+
+Thank you for your interest in contributing to Codebot.
+Here is some information to help you get started:
+
+* Please take a look at the [Code of Conduct](CODE_OF_CONDUCT.md) before
+  contributing to Codebot.
+* Issues and pull requests are always welcome, even if you just want to give
+  feedback or ask a question.
+* If you're planning on working on a major feature, we recommend to first open
+  an issue to discuss your idea.
+* Before creating a pull request, please run `rubocop` and make sure it does
+  not report any offenses.
+* If you need help or have a question, don't hesitate to open an issue and ask.
+  We're here to help!

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    codebot (1.2.0)
+      cinch (~> 2.3)
+      cinch-identify (~> 1.7)
+      irb (~> 1.0)
+      sinatra (~> 2.0)
+      thor (~> 0.20.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    cinch (2.3.4)
+    cinch-identify (1.7.0)
+      cinch (~> 2.0)
+    diff-lcs (1.3)
+    irb (1.0.0)
+    jaro_winkler (1.5.2)
+    mustermann (1.0.3)
+    parallel (1.14.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    psych (3.1.0)
+    rack (2.0.6)
+    rack-protection (2.0.5)
+      rack
+    rainbow (3.0.0)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.65.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    sinatra (2.0.5)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.5)
+      tilt (~> 2.0)
+    thor (0.20.3)
+    tilt (2.0.9)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  codebot!
+  rake (~> 12.3)
+  rspec (~> 3.8)
+  rubocop (~> 0.65.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright © 2018-2019 Janik Rabe
+Copyright © 2019 Ola Bini
+
+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/README.md

@@ -0,0 +1,230 @@
+# Codebot
+
+[![Gem Version](https://badge.fury.io/rb/codebot.svg)](https://rubygems.org/gems/codebot)
+[![Gem Downloads](https://img.shields.io/gem/dt/codebot.svg)](https://rubygems.org/gems/codebot)
+
+Codebot is an IRC bot that receives GitHub and GitLab 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.
+
+In addition, Codebot is able to handle many events the official service does not
+support. Messages for these events are designed to be as consistent as possible
+with official messages. If these additional notifications are not desired, they
+can be disabled through the webhook settings.
+
+## Features
+
+* **Secure by default**. Codebot automatically generates strong random secrets
+  for each webhook to ensure the integrity of received data.
+* **Highly configurable**. Codebot supports IRC over TLS, SASL authentication,
+  password-protected IRC servers, channel keys, address binding, and more.
+* **Easy to set up**. Setting up Codebot takes three minutes — no need to edit
+  configuration files or memorize complicated commands.
+* **Supports many events**. Codebot supports all events supported by GitHub's
+  official IRC integration, and a few more. Individual events can be enabled
+  or disabled through the webhook settings.
+* **Unlimited networks, channels and integrations**. A single instance can
+  receive notifications for any number of webhooks and forward them to the
+  appropriate channels on as many IRC networks as you want.
+* **On-the-fly reloading**. A running Codebot instance can automatically pick
+  up any new changes with no restart required. (*Changes to channel lists
+  currently still require a restart to take effect.*)
+* **Powered by Rack and Sinatra**. Thanks to Rack, Codebot can work with almost
+  any web server, including the default `WEBrick` server for smaller instances.
+
+## Installation
+
+You can install Codebot from [RubyGems][rubygem] by issuing the following
+command:
+
+```
+$ gem install codebot
+```
+
+## Usage
+
+Getting Codebot up and running only takes a few minutes.
+
+### Add a network
+
+First, add the IRC networks you want to send notifications to. Remove `--secure`
+if you need to connect without TLS.
+
+```
+$ codebot network create freenode --host chat.freenode.net --nick bot --secure
+  Network was successfully created
+  Network: freenode
+      Server:     chat.freenode.net:6697 (secure connection)
+      Nickname:   bot
+      SASL authentication disabled
+```
+
+Please see `codebot network help create` for a list of possible options.
+Networks can be modified using `codebot network update` and deleted
+using the `codebot network destroy` command.
+
+### Add an integration
+
+Next, create an integration. Integrations are responsible for mapping a webhook
+endpoint to a set of IRC channels. You can use the same endpoint for as many
+repositories and organizations as you wish.
+
+```
+$ codebot integration create my-project -c freenode/#chan1 freenode/#chan2
+  Integration was successfully created
+  Integration: my-project
+      Endpoint: cc5dc492-1b6a-4e13-9da9-a9cc740add1d
+      Secret:   WIcSmr6bsHmv9EmaONMQ1dViu5ziKYN3gUhXoyZBh3M=
+      Channels:
+          - #chan1 on freenode
+          - #chan2 on freenode
+```
+
+You can specify a custom endpoint using the `--endpoint` option and a custom
+secret using the `--secret` option. If the secret is set to an empty string,
+the integrity of payloads will not be verified. This is highly discouraged.
+
+Please see `codebot integration help create` for a list of possible options.
+Integrations can be modified using `codebot integration update` and deleted
+using the `codebot integration destroy` command.
+
+### Configure your webhook
+
+You can now [add a GitHub webhook][newhook] to any repositories and
+organizations you'd like to receive notifications from.
+
+![Sample webhook configuration](webhook.png)
+
+Unless [otherwise configured][gateway], **Payload URL** should be in the format
+`http://server:4567/endpoint`, where `server` is the IP address or host name of
+the server Codebot is running on, and `endpoint` the endpoint generated in the
+previous step. Please see [Gateway Configuration][gateway] for information on
+how to receive webhooks over HTTPS, and [Environment Variables][environ] if you
+would like Codebot to listen on a different port.
+
+Both possible **Content type** values are supported, but it is recommended to
+use `application/json`.
+
+**Secret** should be set to the secret created in the previous step. This value
+is used for verifying the integrity of received payloads.
+
+You may want to choose **Let me select individual events** if you do not wish
+to receive notifications for all supported events.
+
+### Start Codebot
+
+After adding the webhook to your GitHub repository or organization, you can
+manage your Codebot instance using the following commands:
+
+```
+$ codebot core interactive # Starts Codebot in the foreground (interactively)
+$ codebot core start       # Starts Codebot in the background (as a daemon)
+$ codebot core stop        # Stops the active Codebot instance
+```
+
+For more information, please consult the following commands:
+
+```
+$ codebot help             # General help
+$ codebot help network     # Commands for managing networks
+$ codebot help integration # Commands for managing integrations
+$ codebot help core        # Commands for managing active instances
+```
+
+The configuration is stored in `~/.codebot.yml`, but it is not recommended to
+edit this file manually.
+
+## Environment Variables
+
+Codebot supports the following environment variables:
+
+* `CODEBOT_BIND` sets the address for the web server to bind to. When running
+  Codebot behind a local [gateway server][gateway], this environment variable
+  should be set to a loopback address like `127.0.0.1`.
+* `CODEBOT_PORT` sets the port for the web server to listen on. This defaults
+  to `4567`. If you need to listen on a privileged port, please set up a
+  [gateway server][gateway] instead of trying to run Codebot as root.
+
+## Gateway Configuration
+
+Codebot can optionally run behind a proxy, gateway server or load balancer.
+This allows for additional configuration that would otherwise not be possible,
+such as receiving webhooks over HTTPS.
+
+When accessed through a gateway server, Codebot normally does not need to
+listen on all interfaces. It is therefore recommended to set the `CODEBOT_BIND`
+environment variable to a loopback address before starting Codebot:
+
+```
+$ export CODEBOT_BIND='127.0.0.1'
+```
+
+For larger instances it is recommended to install `thin` before proceeding, as
+the standard `WEBrick` server is single-threaded by default.
+
+```
+$ gem install thin
+```
+
+### lighttpd
+
+lighttpd can be used as a gateway server using the `mod_proxy` module.
+
+First, make sure that the `mod_proxy` module is loaded by adding the following
+line to your `lighttpd.conf` file:
+
+```
+server.modules += ( "mod_proxy" )
+```
+
+Next, configure the module to redirect incoming requests to Codebot:
+
+```
+# Forward requests for an entire domain or subdomain to Codebot
+# Replace codebot.example.com with the subdomain to redirect to Codebot
+# If CODEBOT_BIND is set, replace 127.0.0.1 with the address Codebot listens on
+# If CODEBOT_PORT is set, replace 4567 with the port Codebot listens on
+$HTTP["host"] == "codebot.example.com" {
+  proxy.server = ("/" => ( ( "host" => "127.0.0.1", "port" => 4567 ) ) )
+}
+
+# Alternatively, forward requests for a subdirectory to Codebot
+# Replace /codebot with the subdirectory to redirect to Codebot
+# If CODEBOT_BIND is set, replace 127.0.0.1 with the address Codebot listens on
+# If CODEBOT_PORT is set, replace 4567 with the port Codebot listens on
+proxy.header = ( "map-urlpath" => ( "/codebot" => "" ) )
+proxy.server = ("/codebot" => ( ( "host" => "127.0.0.1", "port" => 4567 ) ) )
+```
+
+That's it! You'll need to reload lighttpd for your changes to take effect.
+
+If lighttpd has been configured correctly and Codebot is running, accessing the
+gateway with a browser should yield a `Method not allowed` error.
+
+## Development
+
+After checking out the repository, run `bundle install` to install dependencies.
+You can also run `bin/console` for an interactive prompt.
+
+During development it is recommended to set the `RACK_ENV` environment variable
+to `development`. This causes the web server to listen only on the loopback
+interface by default.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `metadata.rb` and 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][rubygem].
+
+## Contributing
+
+Bug reports and pull requests are welcome [on GitHub][github].
+Please see the [CONTRIBUTING.md][contrib] for more information.
+
+[github]: https://github.com/olabini/codebot "codebot on GitHub"
+[contrib]: CONTRIBUTING.md "Guidelines for Contributors"
+[rubygem]: https://rubygems.org/gems/codebot "codebot on RubyGems.org"
+[newhook]: https://developer.github.com/webhooks/creating/#setting-up-a-webhook
+[environ]: #environment-variables "Environment Variables"
+[gateway]: #gateway-configuration "Gateway Configuration"