right_hook 0.4.1 → 0.4.2

data/README.md

@@ -9,6 +9,8 @@ Right Hook is a collection of tools to aid in setting up a web app to handle Git
 
 To see some example usage, head over to [right-hook/hookbooks](https://github.com/right-hook/hookbooks).
 
+To see the documentation for the current version of the gem, visit [rubydoc.info](http://rubydoc.info/gems/right_hook).
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/right_hook/app.rb

@@ -4,6 +4,8 @@ require 'json'
 require 'right_hook/event'
 
 module RightHook
+  # Inherit from this class and implement the on_issue, on_pull_request, etc. methods to
+  # configure how you respond to GitHub hooks.
   class App < Sinatra::Base
     post '/hook/:owner/:repo_name/:event_type' do
       owner = params[:owner]
@@ -27,6 +29,11 @@ module RightHook
       end
     end
 
+    # It is up to you to override secret to determine how to look up the correct secret for an owner/repo combo.
+    def secret(owner, repo_name, event_type)
+      raise NotImplementedError, "You didn't specify how to find the secret for a repo!"
+    end
+
     private
     def require_valid_signature(content, owner, repo_name, event_type)
       s = secret(owner, repo_name, event_type)

data/lib/right_hook/spec_helpers.rb

@@ -0,0 +1,28 @@
+require 'openssl'
+require 'uri'
+
+module RightHook
+  # Helpers for specs!
+  # Typical usage is to include this module into your spec context, just like you would with Rack::Test::Methods.
+  module SpecHelpers
+    # Post to the given path, including the correct signature header based on the payload and secret.
+    # @param [Hash] opts The options to use when crafting the request.
+    # @option opts [String] :path The full path of the endpoint to which to post
+    # @option opts [String] :payload A JSON-parseable string containing a payload as described in http://developer.github.com/v3/activity/events/types/
+    # @option opts [String] :secret The secret to use when calculating the HMAC for the X-Hub-Signature header
+    def post_with_signature(opts)
+      path = opts.fetch(:path)
+      payload = opts.fetch(:payload)
+      secret = opts.fetch(:secret)
+
+      post path, {payload: payload}, generate_secret_header(secret, URI.encode_www_form(payload: payload))
+    end
+
+    # :nodoc:
+    def generate_secret_header(secret, body)
+      sha = OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha1'), secret, body)
+      # GitHub sends it as 'X-Hub-Signature', but Rack provides it as HTTP_X_HUB_SIGNATURE... :/
+      {'HTTP_X_HUB_SIGNATURE' => "sha1=#{sha}"}
+    end
+  end
+end

data/lib/right_hook/version.rb

@@ -1,3 +1,3 @@
 module RightHook
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

data/spec/app/issue_spec.rb

@@ -1,10 +1,7 @@
 require 'spec_helper'
-require 'rack/test'
 
 describe RightHook::App do
   describe 'Issues' do
-    include Rack::Test::Methods
-
     class IssueApp < RightHook::App
       class << self
         attr_accessor :owner, :repo_name, :action, :issue_json
@@ -31,9 +28,7 @@ describe RightHook::App do
     end
 
     it 'captures the interesting data' do
-      post '/ignore', {payload: ISSUE_JSON}
-      body = last_request.body.read
-      post '/hook/mark-rushakoff/right_hook/issue', {payload: ISSUE_JSON}, generate_secret_header('issue', body)
+      post_with_signature(path: '/hook/mark-rushakoff/right_hook/issue', payload: ISSUE_JSON, secret: 'issue')
       expect(last_response.status).to eq(200)
       expect(app.owner).to eq('mark-rushakoff')
       expect(app.repo_name).to eq('right_hook')
@@ -44,7 +39,7 @@ describe RightHook::App do
     end
 
     it 'fails when the secret is wrong' do
-      post '/hook/mark-rushakoff/right_hook/issue', {payload: ISSUE_JSON}, generate_secret_header('wrong', 'stuff')
+      post_with_signature(path: '/hook/mark-rushakoff/right_hook/issue', payload: ISSUE_JSON, secret: 'wrong')
       expect(last_response.status).to eq(202)
       expect(app.owner).to be_nil
     end

data/spec/app/pull_request_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'rack/test'
 
 describe RightHook::App do
   describe 'Pull requests' do
@@ -32,9 +31,7 @@ describe RightHook::App do
     end
 
     it 'captures the interesting data' do
-      post '/ignore', {payload: PULL_REQUEST_JSON}
-      body = last_request.body.read
-      post '/hook/mark-rushakoff/right_hook/pull_request', {payload: PULL_REQUEST_JSON}, generate_secret_header('pull_request', body)
+      post_with_signature(path: '/hook/mark-rushakoff/right_hook/pull_request', payload: PULL_REQUEST_JSON, secret: 'pull_request')
       expect(last_response.status).to eq(200)
       expect(app.owner).to eq('mark-rushakoff')
       expect(app.repo_name).to eq('right_hook')
@@ -46,7 +43,7 @@ describe RightHook::App do
     end
 
     it 'fails when the secret is wrong' do
-      post '/hook/mark-rushakoff/right_hook/pull_request', {payload: PULL_REQUEST_JSON}, generate_secret_header('wrong', 'stuff')
+      post_with_signature(path: '/hook/mark-rushakoff/right_hook/pull_request', payload: PULL_REQUEST_JSON, secret: 'wrong')
       expect(last_response.status).to eq(202)
       expect(app.owner).to be_nil
     end

data/spec/app_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
-require 'rack/test'
 
 describe RightHook::App do
-  include Rack::Test::Methods
-
   class BareApp < RightHook::App
     def secret(owner, repo_name, event_type)
       ''
@@ -15,12 +12,16 @@ describe RightHook::App do
   end
 
   it 'is status 501 for a non-implemented hook' do
-    post '/hook/mark-rushakoff/right_hook/issue', '{}', generate_secret_header('secret', '{}')
+    post_with_signature(path: '/hook/mark-rushakoff/right_hook/issue', payload: '{}', secret: '')
     expect(last_response.status).to eq(501)
   end
 
   it 'is 404 for an unknown hook' do
-    post '/hook/mark-rushakoff/right_hook/foobar', '{}', generate_secret_header('secret', '{}')
+    post_with_signature(path: '/hook/mark-rushakoff/right_hook/not_a_real_thing', payload: '{}', secret: '')
     expect(last_response.status).to eq(404)
   end
+
+  it 'raises NotImplementedError for an unimplemented secret' do
+    expect { RightHook::App.new!.secret('owner', 'repo', 'issue') }.to raise_error(NotImplementedError)
+  end
 end

data/spec/spec_helper.rb

@@ -1,19 +1,19 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'right_hook'
 require 'right_hook/app'
 require 'right_hook/authenticated_client'
 require 'right_hook/authenticator'
 require 'right_hook/commenter'
 require 'right_hook/event'
+require 'right_hook/spec_helpers'
 require 'right_hook/subscriber'
 
-require_relative './support/spec_helpers.rb'
-
 require 'webmock/rspec'
+require 'rack/test'
 
 require 'coveralls'
 Coveralls.wear!
 
 RSpec.configure do |c|
+  c.include Rack::Test::Methods
   c.include RightHook::SpecHelpers
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: right_hook
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-01 00:00:00.000000000 Z
+date: 2013-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -176,6 +176,7 @@ files:
 - lib/right_hook/commenter.rb
 - lib/right_hook/event.rb
 - lib/right_hook/logger.rb
+- lib/right_hook/spec_helpers.rb
 - lib/right_hook/subscriber.rb
 - lib/right_hook/version.rb
 - right_hook.gemspec
@@ -189,7 +190,6 @@ files:
 - spec/event_spec.rb
 - spec/spec_helper.rb
 - spec/subscriber_spec.rb
-- spec/support/spec_helpers.rb
 homepage: https://github.com/mark-rushakoff/right_hook
 licenses:
 - MIT
@@ -227,5 +227,4 @@ test_files:
 - spec/event_spec.rb
 - spec/spec_helper.rb
 - spec/subscriber_spec.rb
-- spec/support/spec_helpers.rb
 has_rdoc: 

data/spec/support/spec_helpers.rb

@@ -1,11 +0,0 @@
-require 'openssl'
-
-module RightHook
-  module SpecHelpers
-    def generate_secret_header(secret, body)
-      sha = OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha1'), secret, body)
-      # GitHub sends it as 'X-Hub-Signature', but Rack provides it as HTTP_X_HUB_SIGNATURE... :/
-      {'HTTP_X_HUB_SIGNATURE' => "sha1=#{sha}"}
-    end
-  end
-end