right_hook 0.2.0

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mark Rushakoff
+
+MIT License
+
+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,123 @@
+# Right Hook
+
+[![Build Status](https://travis-ci.org/mark-rushakoff/right_hook.png?branch=master)](https://travis-ci.org/mark-rushakoff/right_hook)
+[![Code Climate](https://codeclimate.com/github/mark-rushakoff/right_hook.png)](https://codeclimate.com/github/mark-rushakoff/right_hook)
+[![Coverage Status](https://coveralls.io/repos/mark-rushakoff/right_hook/badge.png)](https://coveralls.io/r/mark-rushakoff/right_hook)
+
+Right Hook is a collection of tools to aid in setting up a web app to handle GitHub repo hooks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'right_hook'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install right_hook
+
+## Usage
+
+### Your App
+
+Create an application by subclassing `RightHook::App`:
+
+```ruby
+# app.rb
+require 'right_hook/app'
+
+class MyApp < RightHook::App
+  # You must supply a secret for each repository and hook.
+  # The secret should only be known by GitHub; that's how we know the request is coming from GitHub's servers.
+  # (You'll specify that secret when you go through subscription.)
+  def secret(owner, repo_name, event_type)
+    if owner == 'octocat' && repo_name == 'Spoon-Fork' && event_type == 'pull_request'
+      'qwertyuiop'
+    else
+      raise 'unrecognized!'
+    end
+  end
+
+  # 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)
+    message = <<-MSG
+      GitHub user #{pull_request_json['user']['login']} has opened pull request ##{number}
+      on repository #{owner}/#{repo_name}!
+    MSG
+    send_text_message(MY_PHONE_NUMBER, message) # or whatever you want
+  end
+end
+```
+
+You'll need to host your app online and hold on to the base URL so you can subscribe to hooks.
+
+### GitHub Authentication
+
+To create hooks on GitHub repositories, you need to be authenticated as a collaborator on that repository.
+GitHub's UI currently only supports configuring push hooks, so you'll want to authenticate through Right Hook to set up custom hooks.
+
+Right Hook never stores your password.
+He always uses OAuth tokens.
+The only time he asks for your password is when he is creating a new token or listing existing tokens.
+
+Right Hook doesn't store your tokens, either.
+It's your duty to manage storage of tokens.
+
+Here's one way you can generate and list tokens:
+
+```ruby
+require 'right_hook/authenticator'
+
+puts "Please enter your username:"
+username = $stdin.gets
+
+# Prompt the user for their password, without displaying it in the terminal
+authenticator = RightHook::Client.interactive_build(username)
+
+# Note for the token (this will be displayed in the user's settings on GitHub)
+note = "Created in my awesome script"
+authenticator.create_authorization(note)
+
+authenticator.authorizations.each do |token|
+  puts "Token: #{auth.token}\nNote: #{auth.note}\n\n"
+end
+```
+
+### Subscribing to Hooks
+
+Right Hook provides a way to subscribe to hooks.
+It's easy!
+
+```ruby
+require 'right_hook/subscriber'
+
+default_opts = {
+  base_url: "http://right-hook.example.com",
+  oauth_token: ENV['RIGHT_HOOK_TOKEN']
+}
+
+subscriber = RightHook::Subscriber.new(default_opts)
+
+subscriber.subscribe(
+  owner: 'octocat',
+  repo_name: 'Hello-World',
+  event_type: 'pull_request',
+  secret: 'secret_for_hello_world'
+)
+```
+
+(For more details, consult the RDoc documentation.)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/right_hook/app.rb

@@ -0,0 +1,43 @@
+require 'sinatra/base'
+require 'json'
+
+module RightHook
+  class App < Sinatra::Base
+    KNOWN_EVENT_TYPES = %w(
+      pull_request
+      issue
+    )
+
+    post '/hook/:owner/:repo_name/:event_type' do
+      owner = params[:owner]
+      repo_name = params[:repo_name]
+      event_type = params[:event_type]
+      content = request.body.read
+
+      halt 404 unless KNOWN_EVENT_TYPES.include?(event_type)
+      halt 501 unless respond_to?("on_#{event_type}")
+
+      require_valid_signature(content, owner, repo_name, event_type)
+
+      json = JSON.parse(content)
+      case event_type
+      when 'pull_request'
+        on_pull_request(owner, repo_name, json['number'], json['action'], json['pull_request'])
+      when 'issue'
+        on_issue(owner, repo_name, json['action'], json['issue'])
+      else
+        halt 500
+      end
+    end
+
+    private
+    def require_valid_signature(content, owner, repo_name, event_type)
+      s = secret(owner, repo_name, event_type)
+      expected_signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha1'), s, content)
+
+      # http://pubsubhubbub.googlecode.com/git/pubsubhubbub-core-0.4.html#authednotify
+      # "If the signature does not match, subscribers MUST still return a 2xx success response to acknowledge receipt, but locally ignore the message as invalid."
+      halt 202 unless request.env['X-Hub-Signature'] == "sha1=#{expected_signature}"
+    end
+  end
+end

data/lib/right_hook/authenticated_client.rb

@@ -0,0 +1,14 @@
+require 'octokit'
+
+module RightHook
+  # A base class for RightHook actors that interact with the GitHub API.
+  class AuthenticatedClient
+    # Create a new client, authenticating with the given OAuth token.
+    def initialize(token)
+      @client = Octokit::Client.new(access_token: token)
+    end
+
+    private
+    attr_reader :client
+  end
+end

data/lib/right_hook/authenticator.rb

@@ -0,0 +1,38 @@
+module RightHook
+  # The authenticator provides an interface to retrieving or creating GitHub authorizations.
+  class Authenticator
+    class << self
+      # Build a client with a username and an explicit password.
+      def build(username, password)
+        new(Octokit::Client.new(login: username, password: password))
+      end
+
+      # Prompt the user for their password (without displaying the entered keys).
+      # This approach is offered for convenience to make it easier to not store passwords on disk.
+      def interactive_build(username)
+        new(Octokit::Client.new(login: username, password: $stdin.noecho(&:gets).chomp))
+      end
+    end
+
+    # :nodoc:
+    def initialize(_client)
+      @_client = _client
+    end
+
+    # Create a new GitHub authorization with the given note.
+    # If one already exists with that note, it will not create a duplicate.
+    def create_authorization(note)
+      _client.create_authorization(scopes: %w(repo), note: note, idempotent: true).token
+    end
+
+    # Returns an array of all of the authorizations for the authenticated account.
+    def list_authorizations
+      _client.list_authorizations
+    end
+
+    private
+    attr_reader :_client
+    # Enforce use of build methods
+    private_class_method :new
+  end
+end

data/lib/right_hook/commenter.rb

@@ -0,0 +1,11 @@
+require 'right_hook/authenticated_client'
+require 'octokit'
+
+module RightHook
+  # Provides an interface for adding comments on GitHub
+  class Commenter < AuthenticatedClient
+    def comment_on_issue(owner, repo_name, issue_number, comment)
+      client.add_comment("#{owner}/#{repo_name}", issue_number, comment)
+    end
+  end
+end

data/lib/right_hook/subscriber.rb

@@ -0,0 +1,67 @@
+require 'httparty'
+
+module RightHook
+  # Subscriber can subscribe and unsubscribe GitHub hooks to a hosted instance of a specified {RightHook::App}.
+  # See the README for sample usage.
+  class Subscriber
+    # The base URL for the binding (where your {RightHook::App} is hosted).
+    attr_accessor :base_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.
+    attr_accessor :oauth_token
+
+    # The owner of the named repository.
+    attr_accessor :owner
+
+    # The event type of the hook.
+    # See http://developer.github.com/v3/repos/hooks/ for a complete list of valid types.
+    attr_accessor :event_type
+
+    # 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+].
+    def initialize(default_opts = {})
+      @base_url = default_opts[:base_url]
+      @oauth_token = default_opts[:oauth_token]
+      @owner = default_opts[:owner]
+      @event_type = default_opts[:event_type]
+    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.
+    # @return [bool success] Whether the request was successful.
+    def subscribe(opts)
+      hub_request_with_mode('subscribe', opts)
+    end
+
+    # 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.)
+    # @return [bool success] Whether the request was successful.
+    def unsubscribe(opts)
+      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 }
+
+      HTTParty.post('https://api.github.com/hub',
+        headers: {
+          # http://developer.github.com/v3/#authentication
+          'Authorization' => "token #{oauth_token}"
+        },
+        body: {
+          'hub.mode' => mode,
+          'hub.topic' => "https://github.com/#{owner}/#{repo_name}/events/#{event_type}",
+          'hub.callback' => "#{base_url}/hook/#{owner}/#{repo_name}/#{event_type}",
+          'hub.secret' => secret
+        }
+      ).success?
+    end
+  end
+end

data/lib/right_hook/version.rb

@@ -0,0 +1,3 @@
+module RightHook
+  VERSION = "0.2.0"
+end

data/lib/right_hook.rb

@@ -0,0 +1,5 @@
+require "right_hook/version"
+
+module RightHook
+  # Your code goes here...
+end

data/right_hook.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'right_hook/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "right_hook"
+  spec.version       = RightHook::VERSION
+  spec.authors       = ["Mark Rushakoff"]
+  spec.email         = ["mark.rushakoff@gmail.com"]
+  spec.description   = %q{A simple sinatra app ready to go for GitHub service hooks.}
+  spec.summary       = %q{Right Hook is a foundation to use when you just want to write a GitHub service hook.}
+  spec.homepage      = "https://github.com/mark-rushakoff/right_hook"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "webmock", "~> 1.13"
+  spec.add_development_dependency "coveralls"
+
+  spec.add_runtime_dependency "sinatra", "~> 1.4"
+  spec.add_runtime_dependency "httparty", "~> 0.11.0"
+  spec.add_runtime_dependency "octokit", "~> 2.2"
+end

data/spec/app/issue_spec.rb

@@ -0,0 +1,113 @@
+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
+      end
+
+      def on_issue(owner, repo_name, action, issue_json)
+        self.class.owner = owner
+        self.class.repo_name = repo_name
+        self.class.action = action
+        self.class.issue_json = issue_json
+      end
+
+      def secret(owner, repo_name, event_type)
+        'issue' if owner == 'mark-rushakoff' && repo_name == 'right_hook' && event_type == 'issue'
+      end
+    end
+
+    def app
+      IssueApp
+    end
+
+    before do
+      app.owner = app.repo_name = app.action = app.issue_json = nil
+    end
+
+    it 'captures the interesting data' do
+      post '/hook/mark-rushakoff/right_hook/issue', ISSUE_JSON, generate_secret_header('issue', ISSUE_JSON)
+      expect(last_response.status).to eq(200)
+      expect(app.owner).to eq('mark-rushakoff')
+      expect(app.repo_name).to eq('right_hook')
+      expect(app.action).to eq('opened')
+
+      # if it has one key it probably has them all
+      expect(app.issue_json['title']).to eq('Found a bug')
+    end
+
+    it 'fails when the secret is wrong' do
+      post '/hook/mark-rushakoff/right_hook/issue', ISSUE_JSON, generate_secret_header('wrong', ISSUE_JSON)
+      expect(last_response.status).to eq(202)
+      expect(app.owner).to be_nil
+    end
+  end
+end
+
+# from http://developer.github.com/v3/issues/#get-a-single-issue
+ISSUE_JSON = <<-JSON
+{
+  "action": "opened",
+  "issue": {
+    "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347",
+    "html_url": "https://github.com/octocat/Hello-World/issues/1347",
+    "number": 1347,
+    "state": "open",
+    "title": "Found a bug",
+    "body": "I'm having a problem with this.",
+    "user": {
+      "login": "octocat",
+      "id": 1,
+      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+      "gravatar_id": "somehexcode",
+      "url": "https://api.github.com/users/octocat"
+    },
+    "labels": [
+      {
+        "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
+        "name": "bug",
+        "color": "f29513"
+      }
+    ],
+    "assignee": {
+      "login": "octocat",
+      "id": 1,
+      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+      "gravatar_id": "somehexcode",
+      "url": "https://api.github.com/users/octocat"
+    },
+    "milestone": {
+      "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1",
+      "number": 1,
+      "state": "open",
+      "title": "v1.0",
+      "description": "",
+      "creator": {
+        "login": "octocat",
+        "id": 1,
+        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+        "gravatar_id": "somehexcode",
+        "url": "https://api.github.com/users/octocat"
+      },
+      "open_issues": 4,
+      "closed_issues": 8,
+      "created_at": "2011-04-10T20:09:31Z",
+      "due_on": null
+    },
+    "comments": 0,
+    "pull_request": {
+      "html_url": "https://github.com/octocat/Hello-World/pull/1347",
+      "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff",
+      "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch"
+    },
+    "closed_at": null,
+    "created_at": "2011-04-22T13:33:48Z",
+    "updated_at": "2011-04-22T13:33:48Z"
+  }
+}
+JSON

data/spec/app/pull_request_spec.rb

@@ -0,0 +1,205 @@
+require 'spec_helper'
+require 'rack/test'
+
+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
+      end
+
+      def on_pull_request(owner, repo_name, number, 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
+
+      def secret(owner, repo_name, event_type)
+        'pull_request' if owner == 'mark-rushakoff' && repo_name == 'right_hook' && event_type == 'pull_request'
+      end
+    end
+
+    def app
+      PullRequestApp
+    end
+
+    before do
+      app.owner = app.repo_name = app.action = app.number = app.pull_request_json = nil
+    end
+
+    it 'captures the interesting data' do
+      post '/hook/mark-rushakoff/right_hook/pull_request', PULL_REQUEST_JSON, generate_secret_header('pull_request', PULL_REQUEST_JSON)
+      expect(last_response.status).to eq(200)
+      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')
+    end
+
+    it 'fails when the secret is wrong' do
+      post '/hook/mark-rushakoff/right_hook/pull_request', PULL_REQUEST_JSON, generate_secret_header('wrong', PULL_REQUEST_JSON)
+      expect(last_response.status).to eq(202)
+      expect(app.owner).to be_nil
+    end
+  end
+end
+
+# from http://developer.github.com/v3/pulls/#get-a-single-pull-request
+PULL_REQUEST_JSON = <<-JSON
+{
+  "action": "opened",
+  "number": 1,
+  "pull_request": {
+    "url": "https://api.github.com/octocat/Hello-World/pulls/1",
+    "html_url": "https://github.com/octocat/Hello-World/pull/1",
+    "diff_url": "https://github.com/octocat/Hello-World/pulls/1.diff",
+    "patch_url": "https://github.com/octocat/Hello-World/pulls/1.patch",
+    "issue_url": "https://github.com/octocat/Hello-World/issue/1",
+    "number": 1,
+    "state": "open",
+    "title": "new-feature",
+    "body": "Please pull these awesome changes",
+    "created_at": "2011-01-26T19:01:12Z",
+    "updated_at": "2011-01-26T19:01:12Z",
+    "closed_at": "2011-01-26T19:01:12Z",
+    "merged_at": "2011-01-26T19:01:12Z",
+    "head": {
+      "label": "new-topic",
+      "ref": "new-topic",
+      "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+      "user": {
+        "login": "octocat",
+        "id": 1,
+        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+        "gravatar_id": "somehexcode",
+        "url": "https://api.github.com/users/octocat"
+      },
+      "repo": {
+        "id": 1296269,
+        "owner": {
+          "login": "octocat",
+          "id": 1,
+          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+          "gravatar_id": "somehexcode",
+          "url": "https://api.github.com/users/octocat"
+        },
+        "name": "Hello-World",
+        "full_name": "octocat/Hello-World",
+        "description": "This your first repo!",
+        "private": false,
+        "fork": false,
+        "url": "https://api.github.com/repos/octocat/Hello-World",
+        "html_url": "https://github.com/octocat/Hello-World",
+        "clone_url": "https://github.com/octocat/Hello-World.git",
+        "git_url": "git://github.com/octocat/Hello-World.git",
+        "ssh_url": "git@github.com:octocat/Hello-World.git",
+        "svn_url": "https://svn.github.com/octocat/Hello-World",
+        "mirror_url": "git://git.example.com/octocat/Hello-World",
+        "homepage": "https://github.com",
+        "language": null,
+        "forks": 9,
+        "forks_count": 9,
+        "watchers": 80,
+        "watchers_count": 80,
+        "size": 108,
+        "master_branch": "master",
+        "open_issues": 0,
+        "open_issues_count": 0,
+        "pushed_at": "2011-01-26T19:06:43Z",
+        "created_at": "2011-01-26T19:01:12Z",
+        "updated_at": "2011-01-26T19:14:43Z"
+      }
+    },
+    "base": {
+      "label": "master",
+      "ref": "master",
+      "sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+      "user": {
+        "login": "octocat",
+        "id": 1,
+        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+        "gravatar_id": "somehexcode",
+        "url": "https://api.github.com/users/octocat"
+      },
+      "repo": {
+        "id": 1296269,
+        "owner": {
+          "login": "octocat",
+          "id": 1,
+          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+          "gravatar_id": "somehexcode",
+          "url": "https://api.github.com/users/octocat"
+        },
+        "name": "Hello-World",
+        "full_name": "octocat/Hello-World",
+        "description": "This your first repo!",
+        "private": false,
+        "fork": false,
+        "url": "https://api.github.com/repos/octocat/Hello-World",
+        "html_url": "https://github.com/octocat/Hello-World",
+        "clone_url": "https://github.com/octocat/Hello-World.git",
+        "git_url": "git://github.com/octocat/Hello-World.git",
+        "ssh_url": "git@github.com:octocat/Hello-World.git",
+        "svn_url": "https://svn.github.com/octocat/Hello-World",
+        "mirror_url": "git://git.example.com/octocat/Hello-World",
+        "homepage": "https://github.com",
+        "language": null,
+        "forks": 9,
+        "forks_count": 9,
+        "watchers": 80,
+        "watchers_count": 80,
+        "size": 108,
+        "master_branch": "master",
+        "open_issues": 0,
+        "open_issues_count": 0,
+        "pushed_at": "2011-01-26T19:06:43Z",
+        "created_at": "2011-01-26T19:01:12Z",
+        "updated_at": "2011-01-26T19:14:43Z"
+      }
+    },
+    "_links": {
+      "self": {
+        "href": "https://api.github.com/octocat/Hello-World/pulls/1"
+      },
+      "html": {
+        "href": "https://github.com/octocat/Hello-World/pull/1"
+      },
+      "comments": {
+        "href": "https://api.github.com/octocat/Hello-World/issues/1/comments"
+      },
+      "review_comments": {
+        "href": "https://api.github.com/octocat/Hello-World/pulls/1/comments"
+      }
+    },
+    "user": {
+      "login": "octocat",
+      "id": 1,
+      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+      "gravatar_id": "somehexcode",
+      "url": "https://api.github.com/users/octocat"
+    },
+    "merge_commit_sha": "e5bd3914e2e596debea16f433f57875b5b90bcd6",
+    "merged": false,
+    "mergeable": true,
+    "merged_by": {
+      "login": "octocat",
+      "id": 1,
+      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+      "gravatar_id": "somehexcode",
+      "url": "https://api.github.com/users/octocat"
+    },
+    "comments": 10,
+    "commits": 3,
+    "additions": 100,
+    "deletions": 3,
+    "changed_files": 5
+  }
+}
+JSON

data/spec/app_spec.rb

@@ -0,0 +1,26 @@
+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)
+      ''
+    end
+  end
+
+  def app
+    BareApp
+  end
+
+  it 'is status 501 for a non-implemented hook' do
+    post '/hook/mark-rushakoff/right_hook/issue', '{}', generate_secret_header('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', '{}')
+    expect(last_response.status).to eq(404)
+  end
+end

data/spec/authenticated_client_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe RightHook::AuthenticatedClient do
+  describe '.new' do
+    it 'creates an Octokit client with the given token' do
+      Octokit::Client.should_receive(:new).with(access_token: 'the_token')
+
+      described_class.new('the_token')
+    end
+  end
+end

data/spec/authenticator_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'octokit'
+
+describe RightHook::Authenticator do
+  describe '.build' do
+    it 'delegates to Octokit' do
+      Octokit::Client.should_receive(:new).with(login: 'octocat', password: 'pass')
+
+      described_class.build('octocat', 'pass')
+    end
+  end
+
+  describe '.interactive_build' do
+    it 'delegates to Octokit and stdin.noecho' do
+      $stdin.should_receive(:noecho).and_return("pass\n")
+      Octokit::Client.should_receive(:new).with(login: 'octocat', password: 'pass')
+
+      described_class.interactive_build('octocat')
+    end
+  end
+
+  describe '#create_authorization' do
+    it 'delegates to create_authorization' do
+      Octokit::Client.any_instance.should_receive(:create_authorization).with(scopes: %w(repo), note: 'test note', idempotent: true).and_return(OpenStruct.new(token: 'my_token'))
+
+      expect(described_class.build('octocat', 'pass').create_authorization('test note')).to eq('my_token')
+    end
+  end
+
+  describe '#list_authorizations' do
+    it 'delegates to list_authorizations' do
+      Octokit::Client.any_instance.should_receive(:list_authorizations).and_return(:the_authorizations)
+
+      expect(described_class.build('octocat', 'pass').list_authorizations).to eq(:the_authorizations)
+    end
+  end
+end

data/spec/captain_hook_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe RightHook do
+  it 'should have a version number' do
+    RightHook::VERSION.should_not be_nil
+  end
+end

data/spec/commenter_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe RightHook::Commenter do
+  subject(:commenter) do
+    described_class.new('a_token')
+  end
+
+  describe '.comment_on_issue' do
+    it 'delegates to Octokit' do
+      Octokit::Client.any_instance.should_receive(:add_comment).with('octocat/Spoon-Fork', 100, "Wow, 100!")
+
+      commenter.comment_on_issue("octocat", "Spoon-Fork", 100, "Wow, 100!")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$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/subscriber'
+
+require_relative './support/spec_helpers.rb'
+
+require 'webmock/rspec'
+
+require 'coveralls'
+Coveralls.wear!
+
+RSpec.configure do |c|
+  c.include RightHook::SpecHelpers
+end

data/spec/subscriber_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe RightHook::Subscriber do
+  subject(:subscriber) do
+    described_class.new(
+      oauth_token: 'my_token',
+      owner: 'mark-rushakoff',
+      base_url: 'http://example.com',
+      event_type: 'issue',
+    )
+  end
+
+  describe '.subscribe' 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%2Fissue&hub.callback=http%3A%2F%2Fexample.com%2Fhook%2Fmark-rushakoff%2Fright_hook%2Fissue&hub.secret=the-secret',
+             :headers => {'Authorization' => 'token my_token'}
+            ).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)
+
+        expect(stubbed_request).to have_been_requested
+      end
+    end
+
+    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)
+
+        expect(stubbed_request).to have_been_requested
+      end
+    end
+  end
+
+  describe '.unsubscribe' 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%2Fissue&hub.callback=http%3A%2F%2Fexample.com%2Fhook%2Fmark-rushakoff%2Fright_hook%2Fissue&hub.secret=the-secret',
+             :headers => {'Authorization' => 'token my_token'}
+            ).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)
+
+        expect(stubbed_request).to have_been_requested
+      end
+    end
+
+    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)
+
+        expect(stubbed_request).to have_been_requested
+      end
+    end
+  end
+end

data/spec/support/spec_helpers.rb

@@ -0,0 +1,10 @@
+require 'openssl'
+
+module RightHook
+  module SpecHelpers
+    def generate_secret_header(secret, body)
+      sha = OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha1'), secret, body)
+      {'X-Hub-Signature' => "sha1=#{sha}"}
+    end
+  end
+end

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: right_hook
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Mark Rushakoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: A simple sinatra app ready to go for GitHub service hooks.
+email:
+- mark.rushakoff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/right_hook.rb
+- lib/right_hook/app.rb
+- lib/right_hook/authenticated_client.rb
+- lib/right_hook/authenticator.rb
+- lib/right_hook/commenter.rb
+- lib/right_hook/subscriber.rb
+- lib/right_hook/version.rb
+- right_hook.gemspec
+- spec/app/issue_spec.rb
+- spec/app/pull_request_spec.rb
+- spec/app_spec.rb
+- spec/authenticated_client_spec.rb
+- spec/authenticator_spec.rb
+- spec/captain_hook_spec.rb
+- spec/commenter_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
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Right Hook is a foundation to use when you just want to write a GitHub service
+  hook.
+test_files:
+- spec/app/issue_spec.rb
+- spec/app/pull_request_spec.rb
+- spec/app_spec.rb
+- spec/authenticated_client_spec.rb
+- spec/authenticator_spec.rb
+- spec/captain_hook_spec.rb
+- spec/commenter_spec.rb
+- spec/spec_helper.rb
+- spec/subscriber_spec.rb
+- spec/support/spec_helpers.rb
+has_rdoc: