sinatra-github_webhooks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56010d2a9cbff41596e593d634adbed94fe02088
+  data.tar.gz: f5da5c357924b92044f9d84f88f3d337f7c18483
+SHA512:
+  metadata.gz: 6e079d957e8078f40c0e75dcb47f2fff990147f28eb13abaaef21eed4dcf7d7e8a71edbde7515ea4c1ac58ac62971111eb0da430701a7df17715b5f8f4a83170
+  data.tar.gz: c2c3fcd954ddfe92756678d8a9ca86eca37443b7acb1f019af2e2fd45af5e22ade24ed9bf30ed7e85bdd8899393c7489ab2d92da4e40c9546078ba319ce67930

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.0.0
+  - 2.1.7
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## 0.0.1 - 2015-11-29
+
+### Added
+
+- `github_event` method for getting the value of the `X-Github-Event`
+- `payload` method which returns a Hash of the request body after verifying the request signature.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sinatra-github_webhooks.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris Mytton
+
+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,89 @@
+# Sinatra::GithubWebhooks [![Build Status](https://travis-ci.org/chrismytton/sinatra-github_webhooks.svg?branch=master)](https://travis-ci.org/chrismytton/sinatra-github_webhooks)
+
+Helper methods for receiving [GitHub webhooks](https://developer.github.com/webhooks/) with Sinatra.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sinatra-github_webhooks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra-github_webhooks
+
+## Usage
+
+This module provides two methods to use when handling GitHub webhook requests:
+
+- `github_event` This is the value of the `X-Github-Event` header in the request, e.g. `pull_request`
+- `payload`      This is a Hash of the request body after being parsed.
+
+If you provided a webhook secret when you configured your GitHub webhook you can ensure the request comes from GitHub by setting `github_webhook_secret`.
+
+Using this extension in classic style Sinatra apps is as simple as requiring the extension, optionally defining `github_webhook_secret` for verifying webhooks, and using the methods:
+
+```ruby
+require 'sinatra'
+require 'sinatra/github_webhooks'
+
+configure do
+  set :github_webhook_secret, 's3cret'
+end
+
+get '/event_handler' do
+  github_event  # Value of the X-Github-Event header
+  payload       # Hash of the request body
+
+  if github_event == 'pull_request' && payload['action'] == 'opened'
+    # Do something in response to a newly opened Pull Request.
+  end
+  'ok'
+end
+```
+
+Sinatra::Base subclasses need to require and include the module explicitly using the `helpers` method:
+
+```ruby
+require 'sinatra/base'
+require 'sinatra/github_webhooks'
+
+class WebhookApp < Sinatra::Base
+  helpers Sinatra::GithubWebhooks
+
+  configure do
+    set :github_webhook_secret, 's3cret'
+  end
+
+  get '/event_handler' do
+    github_event  # Value of the X-Github-Event header
+    payload       # Hash of the request body
+
+    if github_event == 'pull_request' && payload['action'] == 'opened'
+      # Do something in response to a newly opened Pull Request.
+    end
+    'ok'
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/chrismytton/sinatra-github_webhooks.
+
+
+## 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,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'sinatra/github_webhooks'
+
+# 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.
+
+require 'pry'
+Pry.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/sinatra/github_webhooks/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module GithubWebhooks
+    VERSION = '0.1.0'
+  end
+end

data/lib/sinatra/github_webhooks.rb

@@ -0,0 +1,48 @@
+require 'sinatra/github_webhooks/version'
+
+require 'sinatra/base'
+require 'openssl'
+require 'json'
+
+module Sinatra
+  module GithubWebhooks
+    HMAC_DIGEST = OpenSSL::Digest.new('sha1')
+
+    def github_event
+      request.env['HTTP_X_GITHUB_EVENT']
+    end
+
+    def payload
+      JSON.parse(payload_body)
+    end
+
+    private
+
+    def payload_body
+      request.body.rewind
+      payload_body = request.body.read
+      verify_signature(payload_body)
+      payload_body
+    end
+
+    # Taken from https://developer.github.com/webhooks/securing/
+    def verify_signature(payload_body)
+      unless settings.respond_to?(:github_webhook_secret)
+        logger.warn "No :github_webhook_secret setting found, skipping signature verification"
+        return
+      end
+      signature = 'sha1=' + OpenSSL::HMAC.hexdigest(
+        HMAC_DIGEST,
+        settings.github_webhook_secret,
+        payload_body
+      )
+      signatures_match = Rack::Utils.secure_compare(
+        signature,
+        request.env['HTTP_X_HUB_SIGNATURE']
+      )
+      return halt 500, "Signatures didn't match!" unless signatures_match
+    end
+  end
+
+  helpers GithubWebhooks
+end

data/sinatra-github_webhooks.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sinatra/github_webhooks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sinatra-github_webhooks'
+  spec.version       = Sinatra::GithubWebhooks::VERSION
+  spec.authors       = ['Chris Mytton']
+  spec.email         = ['chrismytton@gmail.com']
+
+  spec.summary       = 'Helper methods for receiving GitHub webhooks with Sinatra'
+  spec.homepage      = 'https://github.com/chrismytton/sinatra-github_webhooks'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'sinatra'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-github_webhooks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Mytton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- chrismytton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sinatra/github_webhooks.rb
+- lib/sinatra/github_webhooks/version.rb
+- sinatra-github_webhooks.gemspec
+homepage: https://github.com/chrismytton/sinatra-github_webhooks
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Helper methods for receiving GitHub webhooks with Sinatra
+test_files: []