github-payload 0.0.1

data/lib/github/payload/helpers/push.rb

@@ -0,0 +1,230 @@
+module GitHub
+  module Payload
+    module Helpers
+      module Push
+        def created?
+          payload['created'] || !!(payload['before'] =~ /0{40}/)
+        end
+
+        def deleted?
+          payload['deleted'] || !!(payload['after'] =~ /0{40}/)
+        end
+
+        def forced?
+          payload['forced']
+        end
+
+        def ref
+          payload['ref'].to_s
+        end
+
+        def base_ref
+          payload['base_ref']
+        end
+
+        def tag?
+          !!(ref =~ %r|^refs/tags/|)
+        end
+
+        def ref_name
+          payload['ref_name'] ||= ref.sub(/\Arefs\/(heads|tags)\//, '')
+        end
+        alias :tag_name :ref_name
+        alias :branch_name :ref_name
+
+        def base_ref_name
+          payload['base_ref_name'] ||= base_ref.sub(/\Arefs\/(heads|tags)\//, '')
+        end
+
+        def before_sha
+          payload['before'][0..6]
+        end
+
+        def after_sha
+          payload['after'][0..6]
+        end
+
+        def format_commit_message(commit)
+          short = commit['message'].split("\n", 2).first
+          "[#{repo_name}/#{branch_name}] #{short} - #{commit['author']['name']}"
+        end
+
+        def commit_messages
+          distinct_commits.map do |commit|
+            format_commit_message(commit)
+          end
+        end
+
+        def summary_message
+          message = []
+          message << "[#{repo_name}] #{pusher_name}"
+
+          if created?
+            if tag?
+              message << "tagged #{tag_name} at"
+              message << (base_ref ? base_ref_name : after_sha)
+            else
+              message << "created #{branch_name}"
+
+              if base_ref
+                message << "from #{base_ref_name}"
+              elsif distinct_commits.empty?
+                message << "at #{after_sha}"
+              end
+
+              if distinct_commits.any?
+                num = distinct_commits.size
+                message << "(+#{num} new commit#{num > 1 ? 's' : ''})"
+              end
+            end
+
+          elsif deleted?
+            message << "deleted #{branch_name} at #{before_sha}"
+
+          elsif forced?
+            message << "force-pushed #{branch_name} from #{before_sha} to #{after_sha}"
+
+          elsif commits.any? and distinct_commits.empty?
+            if base_ref
+              message << "merged #{base_ref_name} into #{branch_name}"
+            else
+              message << "fast-forwarded #{branch_name} from #{before_sha} to #{after_sha}"
+            end
+
+          elsif distinct_commits.any?
+            num = distinct_commits.size
+            message << "pushed #{num} new commit#{num > 1 ? 's' : ''} to #{branch_name}"
+
+          else
+            message << "pushed nothing"
+          end
+
+          message.join(' ')
+        end
+
+        def summary_url
+          if created?
+            if distinct_commits.empty?
+              branch_url
+            else
+              compare_url
+            end
+
+          elsif deleted?
+            before_sha_url
+
+          elsif forced?
+            branch_url
+
+          elsif distinct_commits.size == 1
+            distinct_commits.first['url']
+
+          else
+            compare_url
+          end
+        end
+
+        def repo_url
+          payload['repository']['url']
+        end
+
+        def compare_url
+          payload['compare']
+        end
+
+        def branch_url
+          repo_url + "/commits/#{branch_name}"
+        end
+
+        def before_sha_url
+          repo_url + "/commit/#{before_sha}"
+        end
+
+        def after_sha_url
+          repo_url + "/commit/#{after_sha}"
+        end
+
+        def pusher_name
+          payload.include?('pusher') ? payload['pusher']['name'] : "somebody"
+        end
+
+        def owner_name
+          payload['repository']['owner']['name']
+        end
+
+        def repo_name
+          payload['repository']['name']
+        end
+
+        def name_with_owner
+          File.join(owner_name, repo_name)
+        end
+
+        def commits
+          Array(payload['commits'])
+        end
+
+        def distinct_commits
+          payload['distinct_commits'] ||= Array(commits.select do |commit|
+            commit['distinct'] and !commit['message'].to_s.strip.empty?
+          end)
+        end
+
+        def self.sample_payload
+          {
+            "after"  => "a47fd41f3aa4610ea527dcc1669dfdb9c15c5425",
+            "ref"    => "refs/heads/master",
+            "before" => "4c8124ffcf4039d292442eeccabdeca5af5c5017",
+            "compare" => "http://github.com/mojombo/grit/compare/4c8124f...a47fd41",
+
+            "repository" => {
+              "name"  => "grit",
+              "url"   => "http://github.com/mojombo/grit",
+              "owner" => { "name" => "mojombo", "email" => "tom@mojombo.com" }
+            },
+
+            "pusher" => {
+              "name" => "rtomayko"
+            },
+
+            "commits" => [
+              {
+                "distinct"  => true,
+                "removed"   => [],
+                "message"   => "stub git call for Grit#heads test f:15 Case#1",
+                "added"     => [],
+                "timestamp" => "2007-10-10T00:11:02-07:00",
+                "modified"  => ["lib/grit/grit.rb", "test/helper.rb", "test/test_grit.rb"],
+                "url"       => "http://github.com/mojombo/grit/commit/06f63b43050935962f84fe54473a7c5de7977325",
+                "author"    => { "name" => "Tom Preston-Werner", "email" => "tom@mojombo.com" },
+                "id"        => "06f63b43050935962f84fe54473a7c5de7977325"
+              },
+              {
+                "distinct"  => true,
+                "removed"   => [],
+                "message"   => "clean up heads test f:2hrs",
+                "added"     => [],
+                "timestamp" => "2007-10-10T00:18:20-07:00",
+                "modified"  => ["test/test_grit.rb"],
+                "url"       => "http://github.com/mojombo/grit/commit/5057e76a11abd02e83b7d3d3171c4b68d9c88480",
+                "author"    => { "name" => "Tom Preston-Werner", "email" => "tom@mojombo.com" },
+                "id"        => "5057e76a11abd02e83b7d3d3171c4b68d9c88480"
+              },
+              {
+                "distinct"  => true,
+                "removed"   => [],
+                "message"   => "add more comments throughout",
+                "added"     => [],
+                "timestamp" => "2007-10-10T00:50:39-07:00",
+                "modified"  => ["lib/grit.rb", "lib/grit/commit.rb", "lib/grit/grit.rb"],
+                "url"       => "http://github.com/mojombo/grit/commit/a47fd41f3aa4610ea527dcc1669dfdb9c15c5425",
+                "author"    => { "name" => "Tom Preston-Werner", "email" => "tom@mojombo.com" },
+                "id"        => "a47fd41f3aa4610ea527dcc1669dfdb9c15c5425"
+              }
+            ]
+          }
+        end
+      end
+    end
+  end
+end

data/lib/github/payload/version.rb

@@ -0,0 +1,5 @@
+module GitHub
+  module Payload
+    VERSION = "0.0.1"
+  end
+end

data/test/data_test.rb

@@ -0,0 +1,107 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class DataTest < Formatter::TestCase
+  def test_all_events_presents
+    assert_equal 14, fixture_files.size
+
+    fixture_files.each do |file|
+      content = Yajl.load(File.read(file))
+      receiver = GitHub::Payload.for(content)
+      assert receiver.payload['event']
+    end
+  end
+
+  def test_push_summary
+    content  = load_fixture("push_event")
+    receiver = GitHub::Payload.for(content)
+
+    assert_equal "[test] atmos pushed 1 new commit to master", receiver.summary_message
+    assert_equal "https://github.com/atmos/test/commit/12c8e95fe799c4545d932ee5245ef2a53735d1ae",
+      receiver.summary_url
+  end
+
+  def test_branch_created_summary
+    content  = load_fixture("push_created")
+    receiver = GitHub::Payload.for(content)
+
+    assert_equal "[test] fakeatmos created logo from master", receiver.summary_message
+    assert_equal "https://github.com/atmos/test/commits/logo", receiver.summary_url
+  end
+
+  def test_branch_deleted_summary
+    content  = load_fixture("push_deleted")
+    receiver = GitHub::Payload.for(content)
+
+    assert_equal "[test] fakeatmos deleted logo at dcbb4e7", receiver.summary_message
+    assert_equal "https://github.com/atmos/test/commit/dcbb4e7", receiver.summary_url
+  end
+
+  def test_pull_request_opened_summary
+    content  = load_fixture("pull_request_opened")
+    receiver = GitHub::Payload.for(content)
+
+    assert_equal "[test] fakeatmos opened pull request #2: Update README.md (master...logo)",
+                 receiver.summary_message
+    assert_equal "https://github.com/atmos/test/pull/2", receiver.summary_url
+  end
+
+  def test_pull_request_closed_summary
+    content  = load_fixture("pull_request_closed")
+    receiver = GitHub::Payload.for(content)
+
+    assert_equal "[test] atmos closed pull request #2: Update README.md (master...logo)",
+                 receiver.summary_message
+    assert_equal "https://github.com/atmos/test/pull/2", receiver.summary_url
+  end
+
+  def test_toggling_repo_public
+    content  = load_fixture("public")
+    receiver = GitHub::Payload.for(content)
+
+    assert_equal "[test] atmos just made the repo public.", receiver.summary_message
+    assert_equal "https://github.com/atmos/test", receiver.summary_url
+  end
+
+  def test_issue_opening
+    content  = load_fixture("issues_opened")
+    receiver = GitHub::Payload.for(content)
+
+    assert_equal "[test] fakeatmos opened issue #1: Images would be cool.", 
+      receiver.summary_message
+    assert_equal "https://github.com/atmos/test/issues/1", receiver.summary_url
+  end
+
+  def test_issue_closing
+    content  = load_fixture("issues_closed")
+    receiver = GitHub::Payload.for(content)
+
+    assert_equal "[test] atmos closed issue #1: Images would be cool.", 
+      receiver.summary_message
+    assert_equal "https://github.com/atmos/test/issues/1", receiver.summary_url
+  end
+
+  def test_issue_comment_created
+    content  = load_fixture("issue_comment_created")
+    receiver = GitHub::Payload.for(content)
+
+    assert_equal "[test] atmos just commented.", receiver.summary_message
+    assert_equal "https://api.github.com/repos/atmos/test/issues/comments/19092978",
+      receiver.summary_url
+  end
+
+  def test_created_branch
+    content  = load_fixture("create_branch")
+    receiver = GitHub::Payload.for(content)
+
+    assert_equal "[test] fakeatmos just created logo.", receiver.summary_message
+    assert_equal "https://github.com/atmos/test/commits/logo", receiver.summary_url
+  end
+
+  def test_deleted_branch
+    content  = load_fixture("delete_branch")
+    receiver = GitHub::Payload.for(content)
+
+    assert_equal "[test] fakeatmos just deleted logo.", receiver.summary_message
+    assert_equal "https://github.com/atmos/test", receiver.summary_url
+  end
+end

data/test/fixtures/commit_comment_comment.json

@@ -0,0 +1,143 @@
+{
+  "payload": {
+    "comment": {
+      "url": "https://api.github.com/repos/atmos/test/comments/3375062",
+      "html_url": "https://github.com/atmos/test/commit/dcbb4e731b9588903d1fdda5131ab6125e7bce31#commitcomment-3375062",
+      "id": 3375062,
+      "user": {
+        "login": "atmos",
+        "id": 38,
+        "avatar_url": "https://secure.gravatar.com/avatar/a86224d72ce21cd9f5bee6784d4b06c7?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
+        "gravatar_id": "a86224d72ce21cd9f5bee6784d4b06c7",
+        "url": "https://api.github.com/users/atmos",
+        "html_url": "https://github.com/atmos",
+        "followers_url": "https://api.github.com/users/atmos/followers",
+        "following_url": "https://api.github.com/users/atmos/following{/other_user}",
+        "gists_url": "https://api.github.com/users/atmos/gists{/gist_id}",
+        "starred_url": "https://api.github.com/users/atmos/starred{/owner}{/repo}",
+        "subscriptions_url": "https://api.github.com/users/atmos/subscriptions",
+        "organizations_url": "https://api.github.com/users/atmos/orgs",
+        "repos_url": "https://api.github.com/users/atmos/repos",
+        "events_url": "https://api.github.com/users/atmos/events{/privacy}",
+        "received_events_url": "https://api.github.com/users/atmos/received_events",
+        "type": "User"
+      },
+      "position": null,
+      "line": null,
+      "path": null,
+      "commit_id": "dcbb4e731b9588903d1fdda5131ab6125e7bce31",
+      "created_at": "2013-06-07T07:30:32Z",
+      "updated_at": "2013-06-07T07:30:32Z",
+      "body": ":shipit:"
+    },
+    "repository": {
+      "id": 10544626,
+      "name": "test",
+      "full_name": "atmos/test",
+      "owner": {
+        "login": "atmos",
+        "id": 38,
+        "avatar_url": "https://secure.gravatar.com/avatar/a86224d72ce21cd9f5bee6784d4b06c7?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
+        "gravatar_id": "a86224d72ce21cd9f5bee6784d4b06c7",
+        "url": "https://api.github.com/users/atmos",
+        "html_url": "https://github.com/atmos",
+        "followers_url": "https://api.github.com/users/atmos/followers",
+        "following_url": "https://api.github.com/users/atmos/following{/other_user}",
+        "gists_url": "https://api.github.com/users/atmos/gists{/gist_id}",
+        "starred_url": "https://api.github.com/users/atmos/starred{/owner}{/repo}",
+        "subscriptions_url": "https://api.github.com/users/atmos/subscriptions",
+        "organizations_url": "https://api.github.com/users/atmos/orgs",
+        "repos_url": "https://api.github.com/users/atmos/repos",
+        "events_url": "https://api.github.com/users/atmos/events{/privacy}",
+        "received_events_url": "https://api.github.com/users/atmos/received_events",
+        "type": "User"
+      },
+      "private": true,
+      "html_url": "https://github.com/atmos/test",
+      "description": "",
+      "fork": false,
+      "url": "https://api.github.com/repos/atmos/test",
+      "forks_url": "https://api.github.com/repos/atmos/test/forks",
+      "keys_url": "https://api.github.com/repos/atmos/test/keys{/key_id}",
+      "collaborators_url": "https://api.github.com/repos/atmos/test/collaborators{/collaborator}",
+      "teams_url": "https://api.github.com/repos/atmos/test/teams",
+      "hooks_url": "https://api.github.com/repos/atmos/test/hooks",
+      "issue_events_url": "https://api.github.com/repos/atmos/test/issues/events{/number}",
+      "events_url": "https://api.github.com/repos/atmos/test/events",
+      "assignees_url": "https://api.github.com/repos/atmos/test/assignees{/user}",
+      "branches_url": "https://api.github.com/repos/atmos/test/branches{/branch}",
+      "tags_url": "https://api.github.com/repos/atmos/test/tags",
+      "blobs_url": "https://api.github.com/repos/atmos/test/git/blobs{/sha}",
+      "git_tags_url": "https://api.github.com/repos/atmos/test/git/tags{/sha}",
+      "git_refs_url": "https://api.github.com/repos/atmos/test/git/refs{/sha}",
+      "trees_url": "https://api.github.com/repos/atmos/test/git/trees{/sha}",
+      "statuses_url": "https://api.github.com/repos/atmos/test/statuses/{sha}",
+      "languages_url": "https://api.github.com/repos/atmos/test/languages",
+      "stargazers_url": "https://api.github.com/repos/atmos/test/stargazers",
+      "contributors_url": "https://api.github.com/repos/atmos/test/contributors",
+      "subscribers_url": "https://api.github.com/repos/atmos/test/subscribers",
+      "subscription_url": "https://api.github.com/repos/atmos/test/subscription",
+      "commits_url": "https://api.github.com/repos/atmos/test/commits{/sha}",
+      "git_commits_url": "https://api.github.com/repos/atmos/test/git/commits{/sha}",
+      "comments_url": "https://api.github.com/repos/atmos/test/comments{/number}",
+      "issue_comment_url": "https://api.github.com/repos/atmos/test/issues/comments/{number}",
+      "contents_url": "https://api.github.com/repos/atmos/test/contents/{+path}",
+      "compare_url": "https://api.github.com/repos/atmos/test/compare/{base}...{head}",
+      "merges_url": "https://api.github.com/repos/atmos/test/merges",
+      "archive_url": "https://api.github.com/repos/atmos/test/{archive_format}{/ref}",
+      "downloads_url": "https://api.github.com/repos/atmos/test/downloads",
+      "issues_url": "https://api.github.com/repos/atmos/test/issues{/number}",
+      "pulls_url": "https://api.github.com/repos/atmos/test/pulls{/number}",
+      "milestones_url": "https://api.github.com/repos/atmos/test/milestones{/number}",
+      "notifications_url": "https://api.github.com/repos/atmos/test/notifications{?since,all,participating}",
+      "labels_url": "https://api.github.com/repos/atmos/test/labels{/name}",
+      "created_at": "2013-06-07T07:27:32Z",
+      "updated_at": "2013-06-07T07:29:44Z",
+      "pushed_at": "2013-06-07T07:29:44Z",
+      "git_url": "git://github.com/atmos/test.git",
+      "ssh_url": "git@github.com:atmos/test.git",
+      "clone_url": "https://github.com/atmos/test.git",
+      "svn_url": "https://github.com/atmos/test",
+      "homepage": null,
+      "size": 112,
+      "watchers_count": 0,
+      "language": null,
+      "has_issues": true,
+      "has_downloads": true,
+      "has_wiki": true,
+      "forks_count": 0,
+      "mirror_url": null,
+      "open_issues_count": 1,
+      "forks": 0,
+      "open_issues": 1,
+      "watchers": 0,
+      "master_branch": "master",
+      "default_branch": "master"
+    },
+    "sender": {
+      "login": "atmos",
+      "id": 38,
+      "avatar_url": "https://secure.gravatar.com/avatar/a86224d72ce21cd9f5bee6784d4b06c7?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
+      "gravatar_id": "a86224d72ce21cd9f5bee6784d4b06c7",
+      "url": "https://api.github.com/users/atmos",
+      "html_url": "https://github.com/atmos",
+      "followers_url": "https://api.github.com/users/atmos/followers",
+      "following_url": "https://api.github.com/users/atmos/following{/other_user}",
+      "gists_url": "https://api.github.com/users/atmos/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/atmos/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/atmos/subscriptions",
+      "organizations_url": "https://api.github.com/users/atmos/orgs",
+      "repos_url": "https://api.github.com/users/atmos/repos",
+      "events_url": "https://api.github.com/users/atmos/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/atmos/received_events",
+      "type": "User"
+    }
+  },
+  "event": "commit_comment",
+  "config": {
+    "url": "https://campfire-relaay.herokuapp.com",
+    "content_type": "json",
+    "secret": "563eb98bb765b5c048b9bbd1f4611b2c2beafc1c8fb3678b"
+  },
+  "guid": "229d5c00-cf44-11e2-81c1-e8a63442614c"
+}