lita-github-web-hooks-core 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff338404765098ef6895b51a6b1d804b4d64cfda
+  data.tar.gz: e4e49138c7319db3953aa999e01d4e05473f64c4
+SHA512:
+  metadata.gz: fa7f89f45e0372abbee699ad4d30f11ae0af3fac7c48046e85e4307bb066877349ac269996dd7cb86ed022471a925ecf41a69b357a9ba7ec75ab96dd064a130a
+  data.tar.gz: 178966aad808956ce0640f67330e55236332b698f03cc65951696e58572f860fbe284cf192d4ec332a87dd44ad62600b8e6af8d24228694b8849d8385d15d756

data/.gitignore

@@ -0,0 +1,26 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.6
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lita-github-web-hooks-core.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014, 2015 Jimmy Cuadra, Jim Van Fleet
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 QuietStream Financial, Jim Van Fleet
+
+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,56 @@
+# Lita::Github::WebHooks::Core
+
+Lita and GitHub web hooks are two great tastes that taste great together.
+
+This extension is designed to make using GitHub web hooks as easy as possible in your own handlers.  You may be familiar with the [three types of events](http://docs.lita.io/plugin-authoring/handlers/) Lita supports.  In short, this extension transforms raw data arriving via the [HTTP routing](http://docs.lita.io/plugin-authoring/handlers/#http-routes) system, and publishes a Ruby object (including the original payload) for consumption via an [event route](http://docs.lita.io/plugin-authoring/handlers/#event-routes).  This way, with a simple ```on``` declaration in your handler, you've got the power of the GitHub and Lita at your fingertips.
+
+Installing this extension in your lita bot will not change its behavior.  Extensions are designed to enable handlers, and this one is no exception.  A [simple example handler](https://github.com/GetLevvel/lita-github-web-hooks-storer) demonstrates how easy it can be to get up and running with GitHub Web Hooks in your own bot.
+
+## Installation
+
+Add lita-github-web-hooks-core to your Lita plugin's gemspec:
+
+``` ruby
+spec.add_runtime_dependency "lita-github-web-hooks-core"
+```
+
+And then execute:
+
+    $ bundle
+
+## Hooks and Listeners
+
+A Hook is intended to capture a [Webhook event from GitHub](https://developer.github.com/webhooks/).  There is only one kind of Hook per GitHub API event type.  This extension takes events from the HTTP Post mechanism of interacting with Lita and publishes them on the event mechanism inside lita.  It also provides a collection of data-transfer objects designed to facilitate working with the payloads that GitHub sends along with the webhooks in question within your own plugins.
+
+For example, receipt of a deployment message might query a statistics API to publish performance metrics about the deployment that's being retired.  Tagging a pull request event might trigger a GitHub status update, or a prompt within your chat room for someone to review it.  Want to use [atmos/heaven](https://github.com/atmos/heaven), but have a coffeescript allergy?  This is a great starting place.  Let your imagination be your guide!
+
+## Usage
+
+1. Subclass the HookReceiver Handler class to create something you can mount at a path with http.post and register with Lita
+1. Define a listener, specifying which events you'd want to subscribe to.
+1. Register that listener as a Lita handler.
+
+A [step-by-step walkthrough](https://github.com/GetLevvel/lita-github-web-hooks-storer/blob/master/docs/handler-walkthrough.md)
+ is available at [our example handler](https://github.com/GetLevvel/lita-github-web-hooks-storer/).
+
+
+
+## Configuration
+
+In the chatbot itself, where your own users will be interacting with the bot, the listeners will need to be configured.  Listeners can listen only to particular events, or all events.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then 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.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/GetLevvel/lita-github-web-hooks-core. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lita/github/web/hooks/core"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/lita/extensions/github_web_hooks_core/hook_receiver.rb

@@ -0,0 +1,72 @@
+module Lita
+  module Extensions
+    module GitHubWebHooksCore
+      class HookReceiver < Handler
+
+        def logger
+          Lita.logger
+        end
+
+        def receive_hook(request, response)
+          event_type = event_type_from_request(request)
+          logger.debug("Received #{event_type} webhook")
+          if valid?(request)
+            payload = extract_payload(request)
+            robot.trigger(event_type, payload.merge(event_type: event_type))
+          end
+
+          response.status = 202
+        end
+
+        private
+
+        def event_type_from_request(request)
+          request.env["HTTP_X_GITHUB_EVENT"]
+        end
+
+        def extract_payload(request)
+          case (media_type = request.media_type)
+          when "application/x-www-form-urlencoded"
+            MultiJson.load(request["payload"])
+          when "application/json"
+            MultiJson.load(request.body)
+          else
+            raise "GitHub web hooks: Invalid HTTP Content-Type header: #{media_type}"
+          end
+        end
+
+        def github_cidrs
+          response = http.get("https://api.github.com/meta")
+          data = MultiJson.load(response.body)
+          data["hooks"]
+        end
+
+        def valid?(request)
+          valid_content_type?(request) && valid_ip?(request)
+        end
+
+        def valid_content_type?(request)
+          validity = request.media_type == "application/json"
+          Lita.logger.warn(
+            "GitHub web hook received with invalid media type: #{request.media_type}"
+          ) unless validity
+          validity
+        end
+
+        def valid_ip?(request)
+          ip = request.ip
+          cidrs = github_cidrs || [ "192.30.252.0/22" ]
+
+          # FIXME: github_cidrs has been null in prod?
+          # FIXME: this behaves poorly behind a NAT firewall, allow a whitelist
+          validity = cidrs.any? do |cidr|
+            ::NetAddr::CIDR.create(cidr).contains?(ip)
+          end
+
+          Lita.logger.warn("GitHub web hook received from invalid IP: #{ip}") unless validity
+          validity
+        end
+      end
+    end
+  end
+end

data/lib/lita/extensions/github_web_hooks_core/hooks/commit_comment.rb

@@ -0,0 +1,41 @@
+module Lita::Extensions
+  module GitHubWebHooksCore
+    module Hooks
+      class CommitComment < Hook
+        include Lita::Extensions::GitHubWebHooksCore::Hooks::RepoHooks
+        def commenter
+          payload["sender"]
+        end
+      
+        def url
+          comment["html_url"]
+        end
+      
+        def body
+          comment["body"]
+        end
+      
+        def comment
+          payload["comment"]
+        end
+        
+        def commit_id
+          comment["commit_id"]
+        end
+      
+        def attributes
+          {
+            commenter: commenter,
+            commit_id: commit_id,
+            url: url,
+            body: body,
+            comment: comment,
+            repository: repository,
+            repo: repo
+          }
+        end
+        
+      end
+    end
+  end
+end

data/lib/lita/extensions/github_web_hooks_core/hooks/create.rb

@@ -0,0 +1,27 @@
+module Lita::Extensions
+  module GitHubWebHooksCore
+    module Hooks
+      class Create < Hook
+        include Lita::Extensions::GitHubWebHooksCore::Hooks::RepoHooks
+        def creator
+          payload["sender"]["login"]          
+        end
+        def creation
+          payload["ref_type"]
+        end
+        def creation_name
+          payload["ref"]
+        end
+        def attributes
+          {
+            creator: creator,
+            creation: creation,
+            creation_name: creation_name,
+            repository: repository,
+            repo: repo
+          }
+        end
+      end
+    end
+  end
+end

data/lib/lita/extensions/github_web_hooks_core/hooks/delete.rb

@@ -0,0 +1,27 @@
+module Lita::Extensions
+  module GitHubWebHooksCore
+    module Hooks
+      class Delete < Hook
+        include Lita::Extensions::GitHubWebHooksCore::Hooks::RepoHooks
+        def deletor
+          payload["sender"]["login"]          
+        end
+        def deletion
+          payload["ref_type"]
+        end
+        def deletion_name
+          payload["ref"]
+        end
+        def attributes
+          {
+            deletor: deletor,
+            deletion: deletion,
+            deletion_name: deletion_name,
+            repository: repository,
+            repo: repo
+          }
+        end
+      end
+    end
+  end
+end

data/lib/lita/extensions/github_web_hooks_core/hooks/deployment.rb

@@ -0,0 +1,44 @@
+module Lita::Extensions
+  module GitHubWebHooksCore
+    module Hooks
+      class Deployment < Hook
+        include Lita::Extensions::GitHubWebHooksCore::Hooks::RepoHooks
+        def sha
+          deploy["sha"]
+        end
+      
+        def environment
+          deploy["environment"]
+        end
+      
+        def start_time
+          deploy["created_at"]
+        end
+      
+        def deploy
+          payload["deployment"]
+        end
+      
+        def deployer
+          payload["sender"]["login"]
+        end
+      
+        def ref
+          deploy["ref"]
+        end
+            
+        def attributes
+        {
+          sha: sha,
+          ref: ref,
+          repo: repo,
+          environment: environment,
+          start_time: start_time,
+          deploy: deploy,
+          deployer: deployer
+        }
+        end        
+      end
+    end
+  end
+end

data/lib/lita/extensions/github_web_hooks_core/hooks/deployment_status.rb

@@ -0,0 +1,54 @@
+module Lita::Extensions
+  module GitHubWebHooksCore
+    module Hooks
+      class DeploymentStatus < Hook
+        include Lita::Extensions::GitHubWebHooksCore::Hooks::RepoHooks
+        def status
+          payload["deployment_status"]["state"]
+        end
+      
+        def deployment_description
+          [deploy["description"], status].join(": ")
+        end
+      
+        def sha
+          deploy["sha"]
+        end
+      
+        def environment
+          deploy["environment"]
+        end
+      
+        def start_time
+          deploy["created_at"]
+        end
+      
+        def deploy
+          payload["deployment"]
+        end
+      
+        def deployer
+          payload["sender"]["login"]
+        end
+      
+        def ref
+          deploy["ref"]
+        end      
+      
+        def attributes
+        {
+          status: status,
+          deployment_description: deployment_description,
+          ref: ref,
+          repo: repo,
+          sha: sha,
+          environment: environment,
+          start_time: start_time,
+          deploy: deploy,
+          deployer: deployer
+        }
+        end
+      end
+    end
+  end
+end

data/lib/lita/extensions/github_web_hooks_core/hooks/download.rb

@@ -0,0 +1,8 @@
+module Lita::Extensions
+  module GitHubWebHooksCore
+    module Hooks
+      class Download < Hook
+      end
+    end
+  end
+end

data/lib/lita/extensions/github_web_hooks_core/hooks/follow.rb

@@ -0,0 +1,8 @@
+module Lita::Extensions
+  module GitHubWebHooksCore
+    module Hooks
+      class Follow < Hook
+      end
+    end
+  end
+end

data/lib/lita/extensions/github_web_hooks_core/hooks/fork.rb

@@ -0,0 +1,25 @@
+module Lita::Extensions
+  module GitHubWebHooksCore
+    module Hooks
+      class Fork < Hook
+        include Lita::Extensions::GitHubWebHooksCore::Hooks::RepoHooks
+        def forker
+          payload["sender"]["login"]          
+        end
+        def source
+          payload["forkee"]["full_name"]
+        end
+        def target
+          repo
+        end
+        def attributes
+          {
+            forker: forker,
+            source: source,
+            target: target
+          }
+        end        
+      end
+    end
+  end
+end

data/lib/lita/extensions/github_web_hooks_core/hooks/fork_apply.rb

@@ -0,0 +1,8 @@
+module Lita::Extensions
+  module GitHubWebHooksCore
+    module Hooks
+      class ForkApply < Hook
+      end
+    end
+  end
+end

data/lib/lita/extensions/github_web_hooks_core/hooks/gist.rb

@@ -0,0 +1,8 @@
+module Lita::Extensions
+  module GitHubWebHooksCore
+    module Hooks
+      class Gist < Hook
+      end
+    end
+  end
+end

data/lib/lita/extensions/github_web_hooks_core/hooks/gollum.rb

@@ -0,0 +1,27 @@
+module Lita::Extensions
+  module GitHubWebHooksCore
+    module Hooks
+      class Gollum < Hook
+        include Lita::Extensions::GitHubWebHooksCore::Hooks::RepoHooks
+        def author
+          payload["sender"]["login"]
+        end
+        def title
+          payload["pages"].first["page_name"]
+        end
+        def url
+          payload["pages"].first["html_url"]
+        end
+        def attributes
+          {
+            author: author,
+            title: title,
+            url: url,
+            repository: repository,
+            repo: repo
+          }
+        end
+      end
+    end
+  end
+end

data/lib/lita/extensions/github_web_hooks_core/hooks/hook.rb

@@ -0,0 +1,13 @@
+module Lita::Extensions
+  module GitHubWebHooksCore::Hooks
+    class Hook
+      
+      attr_accessor :payload
+      
+      def initialize(payload)
+        @payload = payload
+      end
+      
+    end
+  end
+end

data/lib/lita/extensions/github_web_hooks_core/hooks/issue_comment.rb

@@ -0,0 +1,49 @@
+module Lita::Extensions
+  module GitHubWebHooksCore
+    module Hooks
+      class IssueComment < Hook
+        include Lita::Extensions::GitHubWebHooksCore::Hooks::RepoHooks
+        def body
+          comment["body"]
+        end
+      
+        def comment
+          payload["comment"]
+        end
+      
+        def commenter
+          payload["sender"]["login"]
+        end
+      
+        def url
+          comment["html_url"]
+        end
+      
+        def issue
+          payload["issue"]
+        end
+      
+        def number
+          issue["number"]
+        end
+      
+        def target
+          issue["title"]
+        end
+      
+        def attributes
+          {
+            body: body,
+            comment: comment,
+            commenter: commenter,
+            number: number,
+            repo: repo,
+            url: url,
+            issue: issue,
+            target: target
+          }
+        end
+      end
+    end
+  end
+end

data/lib/lita/extensions/github_web_hooks_core/hooks/issues.rb

@@ -0,0 +1,35 @@
+module Lita::Extensions
+  module GitHubWebHooksCore
+    module Hooks
+      class Issues < Hook
+        include Lita::Extensions::GitHubWebHooksCore::Hooks::RepoHooks
+        def creator
+          payload["sender"]["login"]
+        end
+        def action
+          payload["action"]
+        end
+        def number
+          payload["issue"]["number"]
+        end
+        def title
+          payload["issue"]["title"]
+        end
+        def url
+          payload["issue"]["html_url"]
+        end
+        def attributes
+          {
+            creator: creator,
+            action: action,
+            number: number,
+            title: title,
+            url: url,
+            repository: repository,
+            repo: repo
+          }
+        end
+      end
+    end
+  end
+end