right_hook 0.4.2 → 0.5.0

data/README.md

@@ -32,6 +32,7 @@ Or install it yourself as:
 Create an application by subclassing `RightHook::App`:
 
 ```ruby
+#!/usr/bin/env ruby
 # app.rb
 require 'right_hook/app'
 require 'right_hook/event'
@@ -51,9 +52,9 @@ class MyApp < RightHook::App
   # Code to execute for GitHub's pull request hook.
   # The secret has already been verified if your code is being called.
   # See app.rb and spec/app/*_spec.rb for signatures and examples of the valid handlers.
-  def on_pull_request(owner, repo_name, action, number, pull_request_json)
+  def on_pull_request(owner, repo_name, action, pull_request_json)
     message = <<-MSG
-      GitHub user #{pull_request_json['user']['login']} has opened pull request ##{number}
+      GitHub user #{pull_request_json['user']['login']} has opened pull request ##{pull_request_json['number']}
       on repository #{owner}/#{repo_name}!
     MSG
     send_text_message(MY_PHONE_NUMBER, message) # or whatever you want
@@ -78,6 +79,7 @@ Typically, tokens and other secret values are stored as environment variables fo
 Here's one way you can generate and list tokens:
 
 ```ruby
+#!/usr/bin/env ruby
 require 'right_hook/authenticator'
 
 puts "Please enter your username:"
@@ -101,6 +103,7 @@ Right Hook provides a way to tell GitHub you want to subscribe your Right Hook a
 It's easy!
 
 ```ruby
+#!/usr/bin/env ruby
 require 'right_hook/subscriber'
 
 default_opts = {
@@ -113,7 +116,7 @@ subscriber = RightHook::Subscriber.new(default_opts)
 subscriber.subscribe(
   owner: 'octocat',
   repo_name: 'Hello-World',
-  event_type: 'pull_request',
+  event_type: RightHook::Event::PULL_REQUEST,
   secret: 'secret_for_hello_world'
 )
 ```

data/lib/right_hook/app.rb

@@ -21,12 +21,14 @@ module RightHook
       json = JSON.parse(params['payload'])
       case event_type
       when Event::PULL_REQUEST
-        on_pull_request(owner, repo_name, json['number'], json['action'], json['pull_request'])
+        on_pull_request(owner, repo_name, json['action'], json['pull_request'])
       when Event::ISSUE
         on_issue(owner, repo_name, json['action'], json['issue'])
       else
         halt 500, "Server bug"
       end
+
+      200
     end
 
     # It is up to you to override secret to determine how to look up the correct secret for an owner/repo combo.
@@ -46,4 +48,12 @@ module RightHook
       halt 202, "Signature mismatch" unless received_signature == calculated_signature
     end
   end
+
+  # Use this class if you're getting a mysterious 500 error in a test and you want to see what went wrong.
+  # Don't use it in production.
+  class DebugApp < App
+    disable :show_exceptions
+    disable :dump_errors
+    enable :raise_errors
+  end
 end

data/lib/right_hook/spec_helpers.rb

@@ -1,10 +1,13 @@
 require 'openssl'
 require 'uri'
+require 'rack/test'
 
 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
+    include Rack::Test::Methods
+
     # 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

data/lib/right_hook/subscriber.rb

@@ -8,6 +8,9 @@ module RightHook
   class Subscriber
     # The base URL for the binding (where your {RightHook::App} is hosted).
     attr_accessor :base_url
+    #
+    # The full target URL for the binding when used with #subscribe_direct.
+    attr_accessor :url
 
     # The OAuth token to use for authenticating with GitHub.
     # The token must belong to an account that has the +repo+ scope and collaborator privilege on the given repository.
@@ -20,18 +23,39 @@ module RightHook
     # See http://developer.github.com/v3/repos/hooks/ for a complete list of valid types.
     attr_accessor :event_type
 
+    # The user agent value to send on the request to github
+    # See: http://developer.github.com/v3/#user-agent-required
+    attr_accessor :user_agent
+
     # Initialize takes options which will be used as default values in other methods.
-    # The valid keys in the options are [+base_url+, +oauth_token+, +owner+, and +event_type+].
+    # The valid keys in the options are [+base_url+, +oauth_token+, +owner+, +event_type+, and +user_agent+].
+    # @param [Hash] opts Subscription options. Defaults to attr_reader methods when such methods exist.
+    # @option opts [String] :owner The owner of the repository
+    # @option opts [String] :event_type A constant under RightHook::Event representing an event type
+    # @option opts [String] :base_url The URL of where the {RightHook::App} is hosted
+    # @option opts [String] :url The URL to receive requests from GitHub when a hook is activated
+    # @option opts [String] :oauth_token The OAuth token to use to authenticate with GitHub when subscribing
+    # @option opts [String] :user_agent The value to send for the User-Agent header when talking with GitHub
     def initialize(default_opts = {})
       @base_url = default_opts[:base_url]
+      @url = default_opts[:url]
       @oauth_token = default_opts[:oauth_token]
       @owner = default_opts[:owner]
       @event_type = default_opts[:event_type]
+      @user_agent = default_opts[:user_agent]
     end
 
     # Subscribe an instance of {RightHook::App} hosted at +base_url+ to a hook for +owner+/+repo_name+, authenticating with +oauth_token+.
     # +repo_name+ and +secret+ are required options and they are intentionally not stored as defaults on the +Subscriber+ instance.
+    # @param [Hash] opts Subscription options. Defaults to attr_reader methods when such methods exist.
     # @return [bool success] Whether the request was successful.
+    # @option opts [String] :owner The owner of the repository
+    # @option opts [String] :repo_name The name of the repository
+    # @option opts [String] :event_type A constant under RightHook::Event representing an event type
+    # @option opts [String] :base_url The URL of where the {RightHook::App} is hosted
+    # @option opts [String] :secret The secret to use to validate that a request came from GitHub. May be omitted
+    # @option opts [String] :oauth_token The OAuth token to use to authenticate with GitHub when subscribing
+    # @option opts [String] :user_agent The value to send for the User-Agent header when talking with GitHub
     def subscribe(opts)
       hub_request_with_mode('subscribe', opts)
     end
@@ -39,36 +63,82 @@ module RightHook
     # Unsubscribe an instance of {RightHook::App} hosted at +base_url+ to a hook for +owner+/+repo_name+, authenticating with +oauth_token+.
     # +repo_name+ and +secret+ are required options and they are intentionally not stored as defaults on the +Subscriber+ instance.
     # (NB: It's possible that GitHub's API *doesn't* require secret; I haven't checked.)
+    # @param [Hash] opts Subscription options. Defaults to attr_reader methods when such methods exist.
     # @return [bool success] Whether the request was successful.
+    # @option opts [String] :owner The owner of the repository
+    # @option opts [String] :repo_name The name of the repository
+    # @option opts [String] :event_type A constant under RightHook::Event representing an event type
+    # @option opts [String] :base_url The URL of where the {RightHook::App} is hosted
+    # @option opts [String] :secret The secret to use to validate that a request came from GitHub. May be omitted
+    # @option opts [String] :oauth_token The OAuth token to use to authenticate with GitHub when subscribing
+    # @option opts [String] :user_agent The value to send for the User-Agent header when talking with GitHub
     def unsubscribe(opts)
       hub_request_with_mode('unsubscribe', opts)
     end
 
+    # Subscribe directly to a fixed URL, rather than a calculated URL for an instance of {RightHook::App}.
+    # @return [bool success] Whether the request was successful.
+    # @param [Hash] opts Subscription options. Defaults to attr_reader methods when such methods exist.
+    # @option opts [String] :owner The owner of the repository
+    # @option opts [String] :repo_name The name of the repository
+    # @option opts [String] :event_type A constant under RightHook::Event representing an event type
+    # @option opts [String] :url The URL to receive requests from GitHub when a hook is activated
+    # @option opts [String] :secret The secret to use to validate that a request came from GitHub. May be omitted
+    # @option opts [String] :oauth_token The OAuth token to use to authenticate with GitHub when subscribing
+    # @option opts [String] :user_agent The value to send for the User-Agent header when talking with GitHub
+    def subscribe_direct(opts)
+      direct_hub_request_with_mode('subscribe', opts)
+    end
+
+    # Unsubscribe directly to a fixed URL, rather than a calculated URL for an instance of {RightHook::App}.
+    # @return [bool success] Whether the request was successful.
+    # @param [Hash] opts Subscription options. Defaults to attr_reader methods when such methods exist.
+    # @option opts [String] :owner The owner of the repository
+    # @option opts [String] :repo_name The name of the repository
+    # @option opts [String] :event_type A constant under RightHook::Event representing an event type
+    # @option opts [String] :url The URL to receive requests from GitHub when a hook is activated
+    # @option opts [String] :secret The secret to use to validate that a request came from GitHub. May be omitted
+    # @option opts [String] :oauth_token The OAuth token to use to authenticate with GitHub when subscribing
+    # @option opts [String] :user_agent The value to send for the User-Agent header when talking with GitHub
+    def unsubscribe_direct(opts)
+      direct_hub_request_with_mode('unsubscribe', opts)
+    end
+
     private
     def hub_request_with_mode(mode, opts)
       repo_name = opts.fetch(:repo_name) # explicitly not defaulted
-      secret = opts.fetch(:secret) # explicitly not defaulted
-      oauth_token = opts.fetch(:oauth_token) { self.oauth_token }
       owner = opts.fetch(:owner) { self.owner }
       base_url = opts.fetch(:base_url) { self.base_url }
       event_type = opts.fetch(:event_type) { self.event_type }
 
+      url = "#{base_url}/hook/#{owner}/#{repo_name}/#{event_type}"
+      direct_hub_request_with_mode(mode, opts.merge(url: url))
+    end
+
+    def direct_hub_request_with_mode(mode, opts)
+      repo_name = opts.fetch(:repo_name) # explicitly not defaulted
+      url = opts.fetch(:url) # explicitly not defaulted
+      secret = opts.fetch(:secret, nil)
+      owner = opts.fetch(:owner) { self.owner }
+      oauth_token = opts.fetch(:oauth_token) { self.oauth_token }
+      event_type = opts.fetch(:event_type) { self.event_type }
+      user_agent = opts.fetch(:user_agent) { self.user_agent }
+
       response = HTTParty.post('https://api.github.com/hub',
         headers: {
           # http://developer.github.com/v3/#authentication
-          'Authorization' => "token #{oauth_token}"
+          'Authorization' => "token #{oauth_token}",
+          'User-Agent' => user_agent.to_s
         },
         body: {
-          'hub.mode' => mode,
-          'hub.topic' => "https://github.com/#{owner}/#{repo_name}/events/#{Event.github_name(event_type)}",
-          'hub.callback' => "#{base_url}/hook/#{owner}/#{repo_name}/#{event_type}",
-          'hub.secret' => secret
-        }
+        'hub.mode' => mode,
+        'hub.topic' => "https://github.com/#{owner}/#{repo_name}/events/#{Event.github_name(event_type)}",
+        'hub.callback' => url,
+        'hub.secret' => secret,
+        },
       )
 
-      RightHook.logger.warn("Failure modifying subscription: #{response.inspect}") unless response.success?
-
-      response.success?
+      raise "Failure modifying direct subscription: #{response.inspect}" unless response.success?
     end
   end
 end

data/lib/right_hook/version.rb

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

data/spec/app/pull_request_spec.rb

@@ -2,18 +2,15 @@ require 'spec_helper'
 
 describe RightHook::App do
   describe 'Pull requests' do
-    include Rack::Test::Methods
-
     class PullRequestApp < RightHook::App
       class << self
-        attr_accessor :owner, :repo_name, :action, :number, :pull_request_json
+        attr_accessor :owner, :repo_name, :action, :pull_request_json
       end
 
-      def on_pull_request(owner, repo_name, number, action, pull_request_json)
+      def on_pull_request(owner, repo_name, action, pull_request_json)
         self.class.owner = owner
         self.class.repo_name = repo_name
         self.class.action = action
-        self.class.number = number
         self.class.pull_request_json = pull_request_json
       end
 
@@ -27,7 +24,7 @@ describe RightHook::App do
     end
 
     before do
-      app.owner = app.repo_name = app.action = app.number = app.pull_request_json = nil
+      app.owner = app.repo_name = app.action = app.pull_request_json = nil
     end
 
     it 'captures the interesting data' do
@@ -36,7 +33,6 @@ describe RightHook::App do
       expect(app.owner).to eq('mark-rushakoff')
       expect(app.repo_name).to eq('right_hook')
       expect(app.action).to eq('opened')
-      expect(app.number).to eq(1)
 
       # if it has one key it probably has them all
       expect(app.pull_request_json['body']).to eq('Please pull these awesome changes')

data/spec/app_spec.rb

@@ -3,25 +3,42 @@ require 'spec_helper'
 describe RightHook::App do
   class BareApp < RightHook::App
     def secret(owner, repo_name, event_type)
-      ''
+      'secret'
     end
   end
 
-  def app
-    BareApp
-  end
+  let(:app) { BareApp }
 
-  it 'is status 501 for a non-implemented hook' do
-    post_with_signature(path: '/hook/mark-rushakoff/right_hook/issue', payload: '{}', secret: '')
-    expect(last_response.status).to eq(501)
-  end
+  context 'An app with no hooks implemented' do
+    it 'is status 501 for a non-implemented hook' do
+      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_with_signature(path: '/hook/mark-rushakoff/right_hook/not_a_real_thing', payload: '{}', secret: '')
-    expect(last_response.status).to eq(404)
+    it 'is 404 for an unknown hook' do
+      post_with_signature(path: '/hook/mark-rushakoff/right_hook/not_a_real_thing', payload: '{}', secret: '')
+      expect(last_response.status).to eq(404)
+    end
   end
 
   it 'raises NotImplementedError for an unimplemented secret' do
     expect { RightHook::App.new!.secret('owner', 'repo', 'issue') }.to raise_error(NotImplementedError)
   end
+
+  describe 'the status of a request' do
+    class WeirdApp < BareApp
+      def on_issue(owner, repo_name, action, issue_json)
+        302
+      end
+    end
+
+    let(:app) { WeirdApp }
+
+    it 'is 200 regardless of what the hook method returns' do
+      payload =  '{}'
+      WeirdApp.any_instance.should_receive(:on_issue).and_call_original
+      post_with_signature(path: '/hook/mark-rushakoff/right_hook/issue', payload: payload, secret: 'secret')
+      expect(last_response.status).to eq(200)
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 require 'right_hook'
 require 'right_hook/app'
 require 'right_hook/authenticated_client'
@@ -10,10 +13,6 @@ require 'right_hook/subscriber'
 require 'webmock/rspec'
 require 'rack/test'
 
-require 'coveralls'
-Coveralls.wear!
-
 RSpec.configure do |c|
-  c.include Rack::Test::Methods
   c.include RightHook::SpecHelpers
 end

data/spec/subscriber_spec.rb

@@ -7,6 +7,7 @@ describe RightHook::Subscriber do
       owner: 'mark-rushakoff',
       base_url: 'http://example.com',
       event_type: RightHook::Event::ISSUE,
+      user_agent: 'My-User-Agent',
     )
   end
 
@@ -14,15 +15,16 @@ describe RightHook::Subscriber do
     let!(:stubbed_request) do
       stub_request(:post, 'https://api.github.com/hub').
         with(:body => 'hub.mode=subscribe&hub.topic=https%3A%2F%2Fgithub.com%2Fmark-rushakoff%2Fright_hook%2Fevents%2Fissues&hub.callback=http%3A%2F%2Fexample.com%2Fhook%2Fmark-rushakoff%2Fright_hook%2Fissue&hub.secret=the-secret',
-             :headers => {'Authorization' => 'token my_token'}
+             :headers => {'Authorization' => 'token my_token', 'User-Agent' => 'My-User-Agent'}
             ).to_return(:status => status_code, :body => '', :headers => {})
     end
 
     context 'When the request succeeds' do
       let(:status_code) { 200 }
-      it 'returns true' do
-        result = subscriber.subscribe(repo_name: 'right_hook', secret: 'the-secret')
-        expect(result).to eq(true)
+      it 'does not raise' do
+        expect {
+          subscriber.subscribe(repo_name: 'right_hook', secret: 'the-secret')
+        }.not_to raise_error
 
         expect(stubbed_request).to have_been_requested
       end
@@ -30,9 +32,10 @@ describe RightHook::Subscriber do
 
     context 'When the request fails' do
       let(:status_code) { 404 }
-      it 'returns false' do
-        result = subscriber.subscribe(repo_name: 'right_hook', secret: 'the-secret')
-        expect(result).to eq(false)
+      it 'raises' do
+        expect {
+          subscriber.subscribe(repo_name: 'right_hook', secret: 'the-secret')
+        }.to raise_error
 
         expect(stubbed_request).to have_been_requested
       end
@@ -41,16 +44,67 @@ describe RightHook::Subscriber do
     context 'When everything is overridden' do
       let(:status_code) { 200 }
       it 'works' do
-        s = described_class.new
-        result = s.subscribe(
-          repo_name: 'right_hook',
-          secret: 'the-secret',
-          oauth_token: 'my_token',
-          owner: 'mark-rushakoff',
-          base_url: 'http://example.com',
-          event_type: RightHook::Event::ISSUE
-        )
-        expect(result).to eq(true)
+        expect {
+          described_class.new.subscribe(
+            repo_name: 'right_hook',
+            secret: 'the-secret',
+            oauth_token: 'my_token',
+            owner: 'mark-rushakoff',
+            base_url: 'http://example.com',
+            event_type: RightHook::Event::ISSUE,
+            user_agent: 'My-User-Agent',
+          )
+        }.not_to raise_error
+
+        expect(stubbed_request).to have_been_requested
+      end
+    end
+  end
+
+  describe '.subscribe_direct' do
+    let!(:stubbed_request) do
+      stub_request(:post, 'https://api.github.com/hub').
+        with(:body => 'hub.mode=subscribe&hub.topic=https%3A%2F%2Fgithub.com%2Fmark-rushakoff%2Fright_hook%2Fevents%2Fissues&hub.callback=http%3A%2F%2Fhook.example.com&hub.secret=the-secret',
+             :headers => {'Authorization' => 'token my_token', 'User-Agent' => 'My-User-Agent'}
+            ).to_return(:status => status_code, :body => '', :headers => {})
+    end
+
+    context 'When the request succeeds' do
+      let(:status_code) { 200 }
+      it 'does not raise' do
+        expect {
+          subscriber.subscribe_direct(repo_name: 'right_hook', secret: 'the-secret', url: 'http://hook.example.com')
+        }.not_to raise_error
+
+        expect(stubbed_request).to have_been_requested
+      end
+    end
+
+    context 'When the request fails' do
+      let(:status_code) { 404 }
+      it 'raises' do
+        expect {
+          subscriber.subscribe_direct(repo_name: 'right_hook', secret: 'the-secret', url: 'http://hook.example.com')
+        }.to raise_error
+
+        expect(stubbed_request).to have_been_requested
+      end
+    end
+
+    context 'When everything is overridden' do
+      let(:status_code) { 200 }
+      it 'works' do
+        expect {
+          described_class.new.subscribe_direct(
+            owner: 'mark-rushakoff',
+            repo_name: 'right_hook',
+            event_type: RightHook::Event::ISSUE,
+            url: 'http://hook.example.com',
+            secret: 'the-secret',
+            oauth_token: 'my_token',
+            user_agent: 'My-User-Agent',
+          )
+        }.not_to raise_error
 
         expect(stubbed_request).to have_been_requested
       end
@@ -61,16 +115,17 @@ describe RightHook::Subscriber do
     let!(:stubbed_request) do
       stub_request(:post, 'https://api.github.com/hub').
         with(:body => 'hub.mode=unsubscribe&hub.topic=https%3A%2F%2Fgithub.com%2Fmark-rushakoff%2Fright_hook%2Fevents%2Fissues&hub.callback=http%3A%2F%2Fexample.com%2Fhook%2Fmark-rushakoff%2Fright_hook%2Fissue&hub.secret=the-secret',
-             :headers => {'Authorization' => 'token my_token'}
+             :headers => {'Authorization' => 'token my_token', 'User-Agent' => 'My-User-Agent'}
             ).to_return(:status => status_code, :body => '', :headers => {})
     end
 
 
     context 'When the request succeeds' do
       let(:status_code) { 200 }
-      it 'returns true' do
-        result = subscriber.unsubscribe(repo_name: 'right_hook', secret: 'the-secret')
-        expect(result).to eq(true)
+      it 'does not raise' do
+        expect {
+          subscriber.unsubscribe(repo_name: 'right_hook', secret: 'the-secret')
+        }.not_to raise_error
 
         expect(stubbed_request).to have_been_requested
       end
@@ -78,9 +133,60 @@ describe RightHook::Subscriber do
 
     context 'When the request fails' do
       let(:status_code) { 404 }
-      it 'returns false' do
-        result = subscriber.unsubscribe(repo_name: 'right_hook', secret: 'the-secret')
-        expect(result).to eq(false)
+      it 'raises' do
+        expect {
+          subscriber.unsubscribe(repo_name: 'right_hook', secret: 'the-secret')
+        }.to raise_error
+
+        expect(stubbed_request).to have_been_requested
+      end
+    end
+  end
+
+  describe '.unsubscribe_direct' do
+    let!(:stubbed_request) do
+      stub_request(:post, 'https://api.github.com/hub').
+        with(:body => 'hub.mode=unsubscribe&hub.topic=https%3A%2F%2Fgithub.com%2Fmark-rushakoff%2Fright_hook%2Fevents%2Fissues&hub.callback=http%3A%2F%2Fhook.example.com&hub.secret=the-secret',
+             :headers => {'Authorization' => 'token my_token', 'User-Agent' => 'My-User-Agent'}
+            ).to_return(:status => status_code, :body => '', :headers => {})
+    end
+
+    context 'When the request succeeds' do
+      let(:status_code) { 200 }
+      it 'does not raise' do
+        expect {
+          subscriber.unsubscribe_direct(repo_name: 'right_hook', secret: 'the-secret', url: 'http://hook.example.com')
+        }.not_to raise_error
+
+        expect(stubbed_request).to have_been_requested
+      end
+    end
+
+    context 'When the request fails' do
+      let(:status_code) { 404 }
+      it 'raises' do
+        expect {
+          subscriber.unsubscribe_direct(repo_name: 'right_hook', secret: 'the-secret', url: 'http://hook.example.com')
+        }.to raise_error
+
+        expect(stubbed_request).to have_been_requested
+      end
+    end
+
+    context 'When everything is overridden' do
+      let(:status_code) { 200 }
+      it 'works' do
+        expect {
+          described_class.new.unsubscribe_direct(
+            owner: 'mark-rushakoff',
+            repo_name: 'right_hook',
+            event_type: RightHook::Event::ISSUE,
+            url: 'http://hook.example.com',
+            secret: 'the-secret',
+            oauth_token: 'my_token',
+            user_agent: 'My-User-Agent',
+          )
+        }.not_to raise_error
 
         expect(stubbed_request).to have_been_requested
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: right_hook
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-02 00:00:00.000000000 Z
+date: 2013-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler